Skip to main content
Version: bleeding-edge 🩸

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.

🗿 Static Functions

tip

The following functions are accessed statically using the specific class with a dot. Example: Character.GetAll().

ReturnsNameDescription
table of Base EntityGetAllReturns a table containing all Entities of the class this is called on
Base EntityGetByIndexReturns a specific Entity of this class at an index
integerGetCountReturns how many Entities of this class exist
table of tableGetInheritedClassesGets a list of all directly inherited classes from this Class created with the Inheriting System
iteratorGetPairsReturns an iterator with all Entities of this class to be used with pairs()
table or nilGetParentClassGets the parent class if this Class was created with the Inheriting System
tableInheritInherits this class with the Inheriting System
booleanIsChildOfGets if this Class is child of another class if this Class was created with the Inheriting System
functionSubscribeSubscribes to an Event for all entities of this Class
functionSubscribeRemoteSubscribes to a custom event called from server
UnsubscribeUnsubscribes 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

— Returns table of Base Entity (Copy of table containing all Entities).

local ret = Entity.GetAll()

GetByIndex

Returns a specific Entity of this class at an index

— Returns Base Entity (Entity at index).

local ret = Entity.GetByIndex(index)
TypeParameterDefaultDescription
integerindex Required parameter The index of the Entity

GetCount

Returns how many Entities of this class exist

— Returns integer (Number of Entities of this class).

local ret = Entity.GetCount()

GetInheritedClasses

Gets a list of all directly inherited classes from this Class created with the Inheriting System

— Returns table of table (All children Classes).

local ret = Entity.GetInheritedClasses(recursively?)
TypeParameterDefaultDescription
booleanrecursively?falseReturns all inherited children

GetPairs

Returns an iterator with all Entities of this class to be used with pairs(). This is a more performant method than GetAll(), as it will return the iterator to access the Entities directly instead of creating and returning a copy of the Entities table.

Note: Destroying Entities from inside a GetPairs() loop will cause the iterable to change size during the process. If you want to loop-and-destroy, please use GetAll().

— Returns iterator (Iterator with all Entities of this class).

local ret = Entity.GetPairs()

GetParentClass

Gets the parent class if this Class was created with the Inheriting System

— Returns table or nil (The parent class).

local ret = Entity.GetParentClass()

Inherit

Inherits this class with the Inheriting System

— Returns table (The new Class table).

local ret = Entity.Inherit(name, custom_values)
TypeParameterDefaultDescription
stringname Required parameter The name of the new Class
table or nilcustom_values Required parameter An optional table with custom values to be set in the inherited class table

IsChildOf

Gets if this Class is child of another class if this Class was created with the Inheriting System

— Returns boolean.

local ret = Entity.IsChildOf(class)
TypeParameterDefaultDescription
tableclass Required parameter The other class to check

Subscribe

Subscribes to an Event for all entities of this Class

— Returns function (Callback that was passed (useful for unsubscribing later if your callback is an anonymous function)).

local ret = Entity.Subscribe(event_name, callback)
TypeParameterDefaultDescription
stringevent_name Required parameter Name of the event to subscribe to
functioncallback Required parameter Function to call when the event is triggered

SubscribeRemote

Subscribes to a custom event called from server

— Returns function (Callback that was passed (useful for unsubscribing later if your callback is an anonymous function)).

local ret = Entity.SubscribeRemote(event_name, callback)
TypeParameterDefaultDescription
stringevent_name Required parameter Name of the event to subscribe to
functioncallback Required parameter Function to call when the event is triggered

Unsubscribe

Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed

Entity.Unsubscribe(event_name, callback?)
TypeParameterDefaultDescription
stringevent_name Required parameter Name of the event to unsubscribe from
functioncallback?nilOptional callback to unsubscribe

🦠 Functions

ReturnsNameDescription
BroadcastRemoteEventCalls a custom remote event directly on this entity to all Players
CallRemoteEventCalls a custom remote event directly on this entity to a specific Player
CallRemoteEventCalls a custom remote event directly on this entity
DestroyDestroys this Entity
table of stringGetAllValuesKeysGets a list of all values keys
tableGetClassGets the class of this entity
integerGetIDGets the universal network ID of this Entity (same on both client and server)
anyGetValueGets a Value stored on this Entity at the given key
booleanIsARecursively checks if this entity is inherited from a Class
booleanIsValidReturns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
SetValueSets a Value in this Entity
functionSubscribeSubscribes to an Event on this specific entity
functionSubscribeRemoteSubscribes to a custom event called from server on this specific entity
UnsubscribeUnsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed

BroadcastRemoteEvent

Calls a custom remote event directly on this entity to all Players

my_entity:BroadcastRemoteEvent(event_name, args...?)
TypeParameterDefaultDescription
stringevent_name Required parameter The Event Name to trigger the event
anyargs...?nilArguments to pass to the event

CallRemoteEvent

Calls a custom remote event directly on this entity to a specific Player

my_entity:CallRemoteEvent(event_name, player, args...?)
TypeParameterDefaultDescription
stringevent_name Required parameter The Event Name to trigger the event
Playerplayer Required parameter The remote player to send this event
anyargs...?nilArguments to pass to the event

CallRemoteEvent

Calls a custom remote event directly on this entity

my_entity:CallRemoteEvent(event_name, args...?)
TypeParameterDefaultDescription
stringevent_name Required parameter The Event Name to trigger the event
anyargs...?nilArguments to pass to the event

Destroy

Destroys this Entity

my_entity:Destroy()

GetAllValuesKeys

Gets a list of all values keys

— Returns table of string (a list with all values keys).

local ret = my_entity:GetAllValuesKeys()

See also GetValue, SetValue.


GetClass

Gets the class of this entity

— Returns table.

local ret = my_entity:GetClass()

GetID

Gets the universal network ID of this Entity (same on both client and server)

— Returns integer.

local ret = my_entity:GetID()

GetValue

Gets a Value stored on this Entity at the given key. Please refer to Entity Values for more information

— Returns any (Value at key or fallback if key doesn't exist).

local ret = my_entity:GetValue(key, fallback)
TypeParameterDefaultDescription
stringkey Required parameter No description provided
anyfallback Required parameter Fallback value if key doesn't exist

See also GetAllValuesKeys, SetValue.


IsA

Recursively checks if this entity is inherited from a Class

— Returns boolean.

local ret = my_entity:IsA(class)
TypeParameterDefaultDescription
tableclass Required parameter The Class

IsValid

Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)

— Returns boolean.

local ret = my_entity:IsValid()

SetValue

Sets a value in this Entity, which can be accessed by any package (optionally sync on clients if called from server)

Please refer to Entity Values for more information

my_entity:SetValue(key, value, sync_on_clients?)
TypeParameterDefaultDescription
stringkey Required parameter No description provided
anyvalue Required parameter No description provided
booleansync_on_clients?falseServer side parameter, if enabled will sync this value with all clients

See also GetAllValuesKeys, GetValue.


Subscribe

Subscribes to an Event on this specific entity

— Returns function (Callback that was passed (useful for unsubscribing later if your callback is an anonymous function)).

local ret = my_entity:Subscribe(event_name, callback)
TypeParameterDefaultDescription
stringevent_name Required parameter Name of the event to subscribe to
functioncallback Required parameter Function to call when the event is triggered

SubscribeRemote

Subscribes to a custom event called from server on this specific entity

— Returns function (Callback that was passed (useful for unsubscribing later if your callback is an anonymous function)).

local ret = my_entity:SubscribeRemote(event_name, callback)
TypeParameterDefaultDescription
stringevent_name Required parameter Name of the event to subscribe to
functioncallback Required parameter Function to call when the event is triggered

Unsubscribe

Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed

my_entity:Unsubscribe(event_name, callback?)
TypeParameterDefaultDescription
stringevent_name Required parameter Name of the event to unsubscribe from
functioncallback?nilOptional callback to unsubscribe

🚀 Events

NameDescription
ClassRegisterTriggered when a new Class is registered with the Inheriting System
DestroyTriggered when an Entity is destroyed
SpawnTriggered when an Entity is spawned/created
ValueChangeTriggered when an Entity has a value changed with :SetValue()

ClassRegister

Triggered when a new Class is registered with the Inheriting System
Entity.Subscribe("ClassRegister", function(class)
-- ClassRegister was called
end)
TypeArgumentDescription
tableclassThe inherited Class

Destroy

Triggered when an Entity is destroyed
Entity.Subscribe("Destroy", function(self)
-- Destroy was called
end)
TypeArgumentDescription
Base EntityselfThe Entity which that was destroyed

Spawn

Triggered when an Entity is spawned/created
Entity.Subscribe("Spawn", function(self)
-- Spawn was called
end)
TypeArgumentDescription
Base EntityselfThe Entity that was spawned

ValueChange

Triggered when an Entity has a value changed with :SetValue()
Entity.Subscribe("ValueChange", function(self, key, value)
-- ValueChange was called
end)
TypeArgumentDescription
Base EntityselfThe Entity that just had a value changed
stringkeyThe key used
anyvalueThe value that was set