Technical Documentation

An Agency is an organization in LSPDFR to which Stations, Peds and Vehicles can belong.   In LSPDFR 0.4, the various agencies (i.e. police agencies, fire departments, etc.) are defined within the Agency XML file.  Generally, an Agency in LSPDFR is a representation of some kind of police or law-enforcement organization, although other entities like fire departments can also be present.     It's worth noting as well that Agencies can be used to represent smaller divisions wit

A ped model is made up of a number of Components, each representing a different body part or accessory.   There are 12 ped component slots in Grand Theft Auto V, numbered 0 thru 11 which can be used.  A component consists of a drawable and a texture, with a drawable being the actual model and a texture being the texture applied to the drawable.  A drawable can have multiple textures, and a component can have multiple drawables although only one can be active at any time.  

respond as backup: excludes it even from responding in categories, such as local patrol (whereas ExcludeFromBackupMenu only hides the agency switch)

An Inventory defines what Weapons (and weapon components) a Ped should be equipped with.   Elements   Element Name Type Required Description Name Text Yes A short name for the Inventory that will be shown in the Police Locker menu. ScriptName Text Yes This is a unique identifier for the Inventory, which is used to refere

A Loadout is like a police unit - it connects a number of Peds to a Vehicle.   Loadouts consist of one or more Vehicles, alongside one or more Peds.  They are used to represent the different units that an Agency has available, and each Loadout is available to be chosen from the Backup Menu if its agency is selected in the menu.   Each vehicle and ped are added to a pool.  When the Loadout is requested (e.g. it is called as backup), one vehicle will be randomly selected from

An Outfit contains one or more outfit Variations that a Ped can have.   The idea of an Outfit is that it can be used as a more generic representation of what a Ped should wear.  Instead of having an outfit that is a "LSPD Sergeant Patrol Uniform", you could instead have a more generic "LSPD Patrol Uniform", which could define the basics of the uniform (e.g. pants, shirt, equipment, etc.) then have "Sergeant" as a variation, which could simply be a different shirt texture.    

A Ped is a representation of a non-player-character (NPC).  A number of attributes are available to define specific variations.   Attributes Attribute Name Type Required Description chance Number No The chance that this ped will be selected in favor of another.  This is a normalized chance, meaning that if each chance attribute for each ped is added up, the total should always b

Props are additional accessories that peds can wear.  They are similar to Components.   There are 5 ped prop slots in Grand Theft Auto V, numbered 0, 1, 2, 6 and 7 which can be used.  A prop is similar to a Component in that it consists of a drawable and a texture, with a drawable being the actual model and a texture being the texture applied to the drawable.  A drawable can have multiple textures, and a component can have multiple drawables although only one can be active at any tim

A Region is a collection of one or more Zones.   In LSPDFR, we use Regions in the Backup XML system, where each Region can be assigned one or more Agencies.   Elements   Element Name Type Required Description Name Text Yes A name that describes the region.  This should not contain any special characters or spaces, as it is used as an XML tag in Backup.XML

SpawnPoint is used to specify Vehicles and Peds that can spawn ambiently at a Station.       Attributes   Attribute Name Type Required Description heading Number Yes The heading (angle in degrees) for the spawn.  This is the angle that the Ped or Vehicle should face (e.g. facing West has a heading of 270). position Position

A Station is a building or place in the game world used by an Agency   The main purpose that Stations serve is to provide a location where the player can access the Duty, Locker and Garage menus - they are the place where the player goes either on or off duty.   Stations are interacted with by entering them, which can be done at the defined position (usually the main door).  As most buildings in Grand Theft Auto V are not enterable, the player will appear in the Locker Room

A Variation is a subset of an Outfit, defining the Components and Props which a Ped should wear.   Variations are the building blocks of the Outfit system.  Like outfits, each variation can be assigned a Name and ScriptName, but variations also introduce a Base attribute which allows for one variation to inherit all the Components of another, which is particularly useful in many situations, especially when creating variations that change accessories but use the same underlying clothe

A Vehicle element simply defines a vehicle by model name.  Aside from this, it can contain a number of attributes which allow for more advanced configurations.   Attributes   Attribute Name Type Required Description Chance Number No The chance that this vehicle will be selected in favor of another.  This is a normalized chance, meaning that if each chance attribute for each vehicle is adde

A Weapon element is a simple representation of an in-game weapon.  They should be used in an Inventory to create different loadouts.   Attributes   Attribute Name Type Required Description Chance Number No The chance that this weapon will be selected in favor of another.  This is a normalized chance, meaning that if each chance attribute for each weapon is added up, the tot

In Grand Theft Auto V, a zone is the shorthand name used to describe a particular area of the map.    Each zone is made up of a number of smaller areas - each one a simple square - and if a position in 2D space is determined to be within one of those squares, it is therefore in that zone.     We use Zones in LSPDFR in the Regions system, where we combine multiple zones into wider regions that can then be used in the Backup XML to assign a particular agency to the region.