Types

This page hosts a list of used data types for scripting.

Types

These types are used in Scripting.
A Sharedtype means that the type is available to be used on both the server and the client in scripting.

• Shared Client - client representation
• Client Effect - effect (FX)
• Shared Element - element
  • Shared Blip - blip
  • Shared Entity - entity
    • Shared Building - building (GTA Building)
    • Shared Physical - object that interacts with physics
      • Shared Object - placeable object
      • Shared Ped - pedestrian
        • Shared Player - player
      • Shared Vehicle - any vehicle
        • Shared Train - train
  • Shared Marker - marker
  • Shared Pickup - pickup
• Shared Event - event
  • Shared CancellableEvent - cancellable event
  • Shared KeyEvent - key event
• Client Font - font
• Client GUIElement - gui element
• Client GUIHtmlElement - gui html element
• Client GUIHtmlView - gui html view
• Client GUIPage - gui page
• Client GUIWindow - gui window
• Shared Matrix4x4 - matrix of 4 by 4 decimal numbers
• Shared ReflectedFunction - reflected function
• Shared Resource - resource
• Client Sound
• Shared Stream
• Client Surface
  • Client RenderTarget - client representation - derives from Surface
  • Client Texture - texture - derives from Surface
• Shared Timer - timer
• Shared Vec2 - vector of 2 decimal numbers
• Shared Vec3 - vector of 3 decimal numbers
• Shared XmlDocument - xml document
• Shared XmlElement - xml element

Types Derived From Element

Types derived from type Element, as shown in the list above.

Blip : Element
Building : Entity : Element
Marker : Element
Object : Physical : Entity : Element
Pickup : Element
Player : Ped : Physical : Entity : Element
Train : Vehicle : Physical : Entity : Element

Abstract Base Types

These types aren't used directly in Scripting. They just represent abstract types used behind the scenes.

• Surface - Anything that is drawable (RenderTarget, Texture)

Scripting-Language Types

These scripting-language types are used in the scripting interface.

Scalar types.

• bool - Also known as boolean.
• float - Number if the scripting language only uses 1 numerical type for ints and floats.
• function - For callbacks.
• int - Number if the scripting language only uses 1 numerical type for ints and floats.
• null - Also known as nil.
• object - For elements. Userdata if Lua.
• string
• undefined - Used in JS.

Container types.

• array<Type> - Table if Lua. Keys start at 1 if Lua, otherwise keys start at 0.
• dictionary<KeyType,ValueType> - Table if Lua.

Other types.

• void - Represents no arguments or no returns.

Handle Existence Span

Type	Side	Handle Creation	Handle Destruction (With 0 handle references left in scripting too)
Client	Server-Side	When a client is attempting to join the server. OnPlayerJoin.	When a client has begun leaving the server. OnPlayerQuit.
Client (Local)	Client-Side	When a client has joined the server, and the local client's client-side has been notified.	n/a
Client (Remote)	Client-Side	When a client has joined the server, and the remote clients' client-side have been notified.	When a client has begun leaving the server, and the remote clients' client-side have been notified.
Player	Server-Side	When the client's player-ped has spawned. OnPedSpawn.	When the client's player-ped has de-spawned. OnPedWasted.
Player (Local)	Client-Side	When the local client's player-ped has spawned. OnPedSpawn.	When the local client's player-ped has de-spawned. OnPedWasted.
Player (Remote)	Client-Side	When any of these qualifying conditions occur: The remote client's player-ped has spawned, assuming the local client's player-ped is spawned. The remote client's player-ped has streamed back into streaming range of the local client's player-ped 3D position, assuming both the local client's player-ped is spawned and depending on qualifying NetFlags values for all applicable elements. The local client's player-ped has spawned. OnPedSpawn OnElementStreamIn.	When any of these qualifying conditions occur: The remote client's player-ped has de-spawned, assuming the local client's player-ped is spawned. The remote client's player-ped has streamed out of streaming range of the local client's player-ped 3D position, assuming both the local client's player-ped is spawned and depending on qualifying NetFlags values for all applicable elements. The local client's player-ped has de-spawned. OnPedWasted OnElementStreamOut.

Please note, a handle that is not properly de-referenced will cause the handle to not be internally destructed.
As a result, this can give the illusion that some functions are broken when they aren't, such as the result of getElementsByType including more than one array entry for the "same element", which are unequal in scripting comparison operators, after internal re-construction, eg. when a client-side player streams out of distance radius of the local player and then streams back in.
To properly de-reference a handle when it's no longer needed, be sure to use delete myVariable; or myVariable = null; in JS, or myVariable = nil in Lua, where applicable.
Continuous attempts of internal destruction of a handle occurs when the qualifying internal destruction reason has occurred, until there are no references remaining in scripting for the handle, rather than only one internal destruction attempt.
A handle becomes invalidated when a handle destruction attempt has first occurred.
Attempting to hold onto a reference of invalidated handles could cause memory exhaustion, and usage of an invalid handle with the scripting API should give a scripting error.

Also, when the local client's player-ped is not spawned, applicable handles will not be usable in client-side scripting.
For example, remote clients' player-ped handles are internally attempted to be destructed when the local client's player-ped de-spawns, until the local client's player-ped re-spawns.

Previous Versions

Type Civilian was removed. All functionality from type Civilianwas moved to type Ped.
Type Transformable was removed. All functionality from type Transformablewas moved to type Element.