Base Entity
Entity is the base for all Classes, and all those entities share the same Methods and Events described in this page.
🧑💻API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
👪Base Class
This is a Base Class. Base Classes are abstract definitions used to share common methods and events between related child classes, thus you cannot spawn it directly.
Classes that share methods and events from this Base Class: Billboard, Blueprint, Cable, Character, CharacterSimple, Decal, Gizmo, Grenade, Light, Melee, Particle, Player, Prop, SceneCapture, StaticMesh, Sound, TextRender, Trigger, VehicleWheeled, VehicleWater, Weapon, WebUI, Widget, Widget3D.
Classes that share methods and events from this Base Class: Billboard, Blueprint, Cable, Character, CharacterSimple, Decal, Gizmo, Grenade, Light, Melee, Particle, Player, Prop, SceneCapture, StaticMesh, Sound, TextRender, Trigger, VehicleWheeled, VehicleWater, Weapon, WebUI, Widget, Widget3D.
🗿 Static Functions
tip
The following functions are accessed statically using the specific class with a dot. Example: Character.GetAll()
.
Returns | Name | Description | |
---|---|---|---|
table of Base Entity | GetAll | Returns a table containing all Entities of the class this is called on | |
Base Entity | GetByIndex | Returns a specific Entity of this class at an index | |
integer | GetCount | Returns how many Entities of this class exist | |
table of table | GetInheritedClasses | Gets a list of all directly inherited classes from this Class created with the Inheriting System | |
iterator | GetPairs | Returns an iterator with all Entities of this class to be used with pairs() | |
table or nil | GetParentClass | Gets the parent class if this Class was created with the Inheriting System | |
table | Inherit | Inherits this class with the Inheriting System | |
boolean | IsChildOf | Gets if this Class is child of another class if this Class was created with the Inheriting System | |
function | Subscribe | Subscribes to an Event for all entities of this Class | |
function | SubscribeRemote | Subscribes to a custom event called from server | |
Unsubscribe | Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed |
GetAll
Returns a table containing all Entities of the class this is called on