Types: Difference between revisions

From GTA Connected
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
This page hosts a list of used [https://en.wikipedia.org/wiki/Data_type data types] for scripting.
This page hosts a list of used [https://en.wikipedia.org/wiki/Data_type data types] for scripting.


==Abstract Base Types==
==Types==
These types aren't used directly in Scripting. They just represent abstract types used behind the scenes.
These types are used in Scripting.<br>
 
A <code>Shared</code>type means that the type is available to be used on both the server and the client in scripting.<br><br>
* <code>Surface</code> - Anything that is drawable (<code>RenderTarget</code>, <code>Texture</code>)
 
==Type Inheritance==
These types are used in Scripting.


* {{Side|shared=1}} <code>Client</code> - client representation
* {{Side|shared=1}} <code>Client</code> - client representation
* {{Side|shared=1}} <code>Effect</code> - effect (FX)
* {{Side|client=1}} <code>Effect</code> - effect (FX)
*  {{Side|shared=1}} <code>Element</code> - element
*  {{Side|shared=1}} <code>Element</code> - element
** {{Side|shared=1}} <code>Transformable</code> - (2D / 3D) positionable element
** {{Side|shared=1}} <code>Transformable</code> - (2D / 3D) positionable element
*** {{Side|shared=1}} <code>Blip</code> - blip
*** {{Side|shared=1}} <code>Blip</code> - blip
*** {{Side|shared=1}} <code>Entity</code> - entity
*** {{Side|shared=1}} <code>Entity</code> - entity
**** {{Side|client=1}} <code>Building</code> - building (GTA Building)
**** {{Side|shared=1}} <code>Building</code> - building (GTA Building)
**** {{Side|shared=1}} <code>Physical</code> - object that interacts with physics
**** {{Side|shared=1}} <code>Physical</code> - object that interacts with physics
***** {{Side|client=1}} <code>Object</code> - placeable object
***** {{Side|shared=1}} <code>Object</code> - placeable object
***** {{Side|client=1}} <code>Ped</code> - pedestrian
***** {{Side|shared=1}} <code>Ped</code> - pedestrian
****** {{Side|client=1}} <code>Player</code> - player
****** {{Side|shared=1}} <code>Player</code> - player
***** {{Side|shared=1}} <code>Vehicle</code> - any vehicle
***** {{Side|shared=1}} <code>Vehicle</code> - any vehicle
****** {{Side|server=1}} <code>Train</code> - train
****** {{Side|shared=1}} <code>Train</code> - train
*** {{Side|client=1}} <code>Marker</code> - marker
*** {{Side|shared=1}} <code>Marker</code> - marker
*** {{Side|shared=1}} <code>Pickup</code> - pickup
*** {{Side|shared=1}} <code>Pickup</code> - pickup
* {{Side|shared=1}} <code>Event</code> - event
* {{Side|shared=1}} <code>Event</code> - event
* {{Side|shared=1}} <code>Font</code> - font
** {{Side|shared=1}} <code>CancellableEvent</code> - cancellable event
** {{Side|shared=1}} <code>KeyEvent</code> - key vent
* {{Side|client=1}} <code>Font</code> - font
* {{Side|shared=1}} <code>Matrix4x4</code> - matrix of 4 by 4 numbers
* {{Side|shared=1}} <code>Matrix4x4</code> - matrix of 4 by 4 numbers
* {{Side|shared=1}} <code>ReflectedFunction</code> - reflected function
* {{Side|shared=1}} <code>ReflectedFunction</code> - reflected function
Line 38: Line 36:
* {{Side|shared=1}} <code>Vec2</code> - vector of 2 numbers
* {{Side|shared=1}} <code>Vec2</code> - vector of 2 numbers
* {{Side|shared=1}} <code>Vec3</code> - vector of 3 numbers
* {{Side|shared=1}} <code>Vec3</code> - vector of 3 numbers
* {{Side|server=1}} <code>World</code> - the world
* {{Side|shared=1}} <code>XmlDocument</code> - xml document
* {{Side|shared=1}} <code>XmlElement</code> - xml element
 
==Types Derived From Element==
 
Types derived from type Element, as shown in the list above.


{{InformationBox|1=
{{InformationBox|1=
Blip : Transformable : Element
Blip : Transformable : Element
Building : Entity : Transformable : Element
Building : Entity : Transformable : Element
Civilian : Ped : Physical : Entity : Transformable : Element
Marker : Transformable : Element
Marker : Transformable : Element
Object : Physical : Entity : Transformable : Element
Object : Physical : Entity : Transformable : Element
Line 50: Line 52:
Train : Vehicle : Physical : Entity : Transformable : Element}}
Train : Vehicle : Physical : Entity : Transformable : Element}}


==Type List==
==Abstract Base Types==
This is a list of all types used by GTAC scripting.
These types aren't used directly in Scripting. They just represent abstract types used behind the scenes.


{| class="wikitable"
* <code>Surface</code> - Anything that is drawable (<code>RenderTarget</code>, <code>Texture</code>)
!Type
!Inherited Type
!Endpoint
|-
|Blip
|Transformable
|Shared
|-
|Building
|Entity
|Client-side
|-
|Civilian
|Ped
|Client-side
|-
|Client
| -
|Shared
|-
|Effect
| -
|Client-side
|-
|Element
| -
|Shared
|-
|Entity
|Transformable
|Shared
|-
|Event
| -
|Shared
|-
|Font
| -
|Client-side
|-
|Marker
|Transformable
|Client-side
|-
|Matrix4x4
| -
|Shared
|-
|Object
|Physical
|Client-side
|-
|Ped
|Physical
|Client-side
|-
|Physical
|Entity
|Shared
|-
|Pickup
|Transformable
|Client-side
|-
|Player
|Ped
|Client-side
|-
|ReflectedFunction
| -
|Shared
|-
|RenderTarget
| -
|Client-side
|-
|Resource
| -
|Shared
|-
|Sound
| -
|Client-side
|-
|Stream
| -
|Shared
|-
|Texture
| -
|Client-side
|-
|Timer
| -
|Shared
|-
|Train
|Vehicle
|Server-side
|-
|Transformable
|Element
|Shared
|-
|Vec2
| -
|Shared
|-
|Vec3
| -
|Shared
|-
|Vehicle
|Phsyical
|Shared
|-
|World
| -
|Server-side
|}


==Previous Versions==
==Previous Versions==


Type <code>Civilian</code> was removed. All functionality from type <code>Civilian</code>was moved to type <code>Ped</code>.
Type <code>Civilian</code> was removed. All functionality from type <code>Civilian</code>was moved to type <code>Ped</code>.

Revision as of 20:16, 5 October 2021

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 Transformable - (2D / 3D) positionable 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 vent
  • Client Font - font
  • Shared Matrix4x4 - matrix of 4 by 4 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 numbers
  • Shared Vec3 - vector of 3 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 : Transformable : Element
Building : Entity : Transformable : Element
Marker : Transformable : Element
Object : Physical : Entity : Transformable : Element
Pickup : Transformable : Element
Player : Ped : Physical : Entity : Transformable : Element
Train : Vehicle : Physical : Entity : Transformable : 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)

Previous Versions

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