FrameworkZ API Documentation - FrameworkZ.Entities

Home / FrameworkZ.Entities Module

FrameworkZ.Entities

module

Entities module for FrameworkZ. Defines and interacts with ENTITY object.

4
Functions
8
Methods
1
Fields

📋 On This Page

Fields

1
FrameworkZ.Entities 📋 table
Entities module for FrameworkZ. Defines and interacts with ENTITY object.
Initial value: {}

Methods

8

FrameworkZ.Entities:EmitSound(worldObject, sound)

method undocumented
No documentation available

Parameters (inferred)

worldObject ❓ unknown
Parameter inferred from function signature
sound ❓ unknown
Parameter inferred from function signature

FrameworkZ.Entities:GetData(worldObject, index)

method undocumented
No documentation available

Parameters (inferred)

worldObject ❓ unknown
Parameter inferred from function signature
index ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Entities:GetEntityByID(entityID)

method
Get an entity by their ID.

Parameters

entityID 📝 string
The entity's ID.

Returns

📋 table
Entity Object

FrameworkZ.Entities:Initialize(data, name)

method
Initialize an entity.

Parameters

data 📋 table
The entity's object data
name 📝 string
The entity's name (i.e. ID)

Returns

📝 string
Entity ID

FrameworkZ.Entities:IsEntity(object)

method
Checks if an object is an entity (needs optimization from cached entities).

Parameters

object 📋 table
The object to check.

Returns

✅ boolean
Whether or not the object is an entity and its entity ID if it is an entity.
🔢 integer
The entity ID if the object is an entity.

FrameworkZ.Entities:LoadGridsquare(square)

method undocumented
No documentation available

Parameters (inferred)

square ❓ unknown
Parameter inferred from function signature

FrameworkZ.Entities:New(name)

method
Create a new entity object.

Parameters

name 📝 string
The entity's name (i.e. ID).
square 📋 table
The square the entity is on.

Returns

📋 table
The entity's object table.

FrameworkZ.Entities:SetData(worldObject, index, value)

method undocumented
No documentation available

Parameters (inferred)

worldObject ❓ unknown
Parameter inferred from function signature
index ❓ unknown
Parameter inferred from function signature
value ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

Functions

4

FrameworkZ.Entities.OnGameStart()

function undocumented
No documentation available

FrameworkZ.Entities.OnObjectAboutToBeRemoved(object)

function undocumented
No documentation available

Parameters (inferred)

object ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Entities.OnObjectAdded(object)

function
Called when an object is added to the world. Adds the entity to the object's mod data.

Parameters

object 📋 table
The object that was added to the world.

FrameworkZ.Entities.OnPreFillWorldObjectContextMenu(player, context, worldObjects, test)

function undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
context ❓ unknown
Parameter inferred from function signature
worldObjects ❓ unknown
Parameter inferred from function signature
test ❓ unknown
Parameter inferred from function signature