YSI:File List
From SA-MP Wiki
Below is a list of all the files in the YSI script and a brief description of their purpose. All folders are relative the server directory by default.
Contents |
/filterscripts
- _YSI EXAMPLE SCRIPTS WANTED_.pwn
This is just a dummy file which will appear first in most people's file lists, it's basically an advert.
- YDBG.pwn
This is an in-game editor designed specifically for YSI, it currently only provides placement and menu driven configuration of properties, banks and ammunations.
- YSS.pwn
This is a placeholder for a future YSI based admin system.
/gamemodes
- _YSI EXAMPLE SCRIPTS WANTED_.pwn
This is just a dummy file which will appear first in most people's file lists, it's basically an advert.
- YRPG.pwn
This is a placeholder for a future YSI based RPG mode.
- YSI_Area51.pwn
This is the area 51 mode converted to YSI.
- YSI_LVDM_LG.pwn
This was the LVDM~Land Grab mode converted to YSI but has become a bit of a testing ground used by the lead developer.
- YSI_Manhunt_LV.pwn
This is the Manhunt Las Venturas mode converted to YSI.
- YSI_minigunmadness.pwn
This is the Minigun Madness mode converted to YSI.
- YSI_Monster.pwn
This is the Monster Freeroam mode converted to YSI.
/pawno
- new.pwn
This is the YSI replacement for the code which appears when you click new in pawno, it has all the standard callbacks converted to the Script_ system.
See also: Standard Callbacks.
/include
- YSI.inc
This is the file where all the API functions are listed and where all the other libraries are included from. The functions need to be listed here as only files in the /include folder are checked for native declarations by pawno. As YSI functions are not native and thus declaring them so would be wrong functions which should appear in the function list are declared native in block comments so the compiler ignores them but the editor doesn't.
/YSI
- readme.txt
This is an outdated version of the YSI documentation.
- YSI_debug.own
This file provides a number of debug functions which can be used throughout your code and will only be compiled when a debug compile is made.
- YSI_dependencies.own
This file contains a number of relations between files, ensuring that if a file is wanted files it uses are also compiled (or, more accurately, that if a file is not wanted files using it are not compiled. It is also where optional compilation options are parsed.
- YSI_misc.own
This file contains a number of generic functions used throughout YSI.
- YSI_post.own
This file suppresses a number of warnings and errors when certain compilation configurations are used.
/Core
- YSI_bintree.own
This file contains binary tree manipulation code for use in the command system and other places where a binary tree may be required (none in YSI currently).
See also: Binary Trees.
- YSI_bin.own
This file contains code for the manipulation of bit arrays. A cell contains 32 bits but most people use an entire cell to store a binary value (i.e. a yes or no, 1 or 0, true or false etc), one piece of information per player is up to a 200 cell array, compared to a 7 cell bit array for exactly the same data.
- YSI_commands.own
This file contains the advanced command processor YSI uses, including dynamic addition and removal of commands, dynamic renaming of commands, optional prefixes on commands from YSI, listing of all commands available to a player in the /commands command, integrated permissions and help systems ad more.
- YSI_format.own
This file contains expanded versions of the printf and format functions with additional options and code to support the YSI text system.
- YSI_help.own
This file provides the /help command used in YSI, including the /help <command> code to get help on any command in YSI.
- YSI_INI.own
This file provides the INI system used by YSI including write buffering to reduce disk access and increase speed on writing and block loads for reduced disk access and increased speed on reading.
- YSI_languages.own
This file provides file loading for the YSI text system, multiple languages can be loaded from external text files simultaneously. It also provides the /language command for a person to change the language they get system messages in dynamically. Default languages include German, Danish, English, Spanish, French, Dutch, Polish and Swedish. It also loads the format files used to dynamically style text without altering the mode.
- YSI_player.own
This file provides the integrated user system used by YSI, including /login, /register and more. Features include ease of data saving and loading, multiple names per account, indexes for fast user searching and multiple hashes.
- YSI_td.own
This file is only in the zipped version and is incomplete and not included in code.
- YSI_text.own
This file provides the front end functionality of the text system, allowing a script writer to simply specify which text they want displaying (not the text itself) and the language system will display the text from the relevant file. Also provides additional text functions for in-line formatting, group sends and more.
- YSI_XML.own
This file provides the core functionality to parse an XML based on a provided set of rules.
/Gamemode
- YSI_classes.own
This file contains the code for the advanced class system in YSI, providing dynamic addition and deletion of classes from an individual player's selection list.
- YSI_loader.own
This file contains the code to load MTA .map files, either an entire race using the race and object systems or just the objects.
- YSI_properties.own
This file has the code for the property, bank, ammunation, money area, money point, teleport and forbidden area systems.
/Server
- YSI_modules.own
This file has the code for loading filterscript modules into the main gamemode.
/Setup
- YSI_master.own
This file provides the backend for the YSI master distribution system which links multiple YSI scripts running on the server into each other to allow interaction between the streamers, command systems and more.
- YSI_timers.own
This file provides the backend code to offset timers from each other and distribute server loads for reduced CPU spikes and lag.
/System
- YSI_callbacks.own
This file provides a number of new callbacks for use in gamemodes.
- YSI_default.own
This file calls all internal functions required to be called on callback invocation.
- YSI_groups.own
This file controls the groups system in YSI, replacing admins levels, teams and other systems with a more flexible system.
- YSI_itter.own
This file contains the code for the player iteration system which improves performance in player based loops.
- YSI_script.own
This file provides the Script_ system which wrap the default public callbacks to seamlessly call all internal functions.
/Tracking
- YSI_live.own
This file provides external interfaces for making server and player stats available.
/Visual
- YSI_areas.own
This file does the processing for detecting player's entering map areas and provides an API for adding and removing multiple shapes of areas.
- YSI_checkpoints.own
This file does the processing for streaming checkpoints and provides an API for adding and removing them.
- YSI_objects.own
This file does the processing for streaming objects using a zone based system to increase the streaming efficiency and provides an API for many object functions.
- YSI_pickups.own
This file does the processing for streaming pickups and provides an API for adding and removing them.
- YSI_race.own
This file creates and processes races.
- YSI_zones.own
This file does the processing for gang wars and provides an API for adding and removing zones which can be fought over.
/PHP
- style.css
Basic style sheet for YSI websites. YSI.php Start of a YSI interaction site.
/YSI
- YSI_ini.php
Provides an INI API similar to the PAWN version.
- YSI_live.php
Interacts with the external interfaces provided by YSI_live.own.
- YSI_output.php
Empty.
- YSI_settings.php
Customization options for PHP code.
- YSI_users.php
Empty.
/scriptfiles
/YSI
- core.DE
Standard text in German.
- core.DK
Standard text in Danish.
- core.EN
Standard text in English.
- core.ES
Standard text in Spanish.
- core.FR
Standard text in French.
- core.NL
Standard text in Dutch.
- core.PL
Standard text in Polish.
- core.SE
Standard text in Swedish.
- core_format.YSI
Formatting data for standard text.
- core_LANG_DATA.yml
Only in certain packages, related to YSI_td.own, experimental XML based text-draw supporting format system. Unused.
/users
Files created when users register.
/YDBG
- props.XML
Saved data from YDBG.pwn.
