Skip to content

LuaComponent.md

Latest commit

 

History

History
32 lines (20 loc) · 1.02 KB

LuaComponent.md

File metadata and controls

32 lines (20 loc) · 1.02 KB
Raw

LuaComponent

Component that specifies the list of lua scripts to be run for the Entity it is attached to.

Scripts can use the self global variable to access the Entity they are attached to.

In all the following functions, a script is the path to a file containing a script, NOT THE ACTUAL SCRIPT CODE.

Specs

Members

Types

using script = putils::string<KENGINE_MAX_LUA_SCRIPT_PATH>;
using script_vector = putils::vector<script, KENGINE_MAX_LUA_SCRIPTS>;

scripts

script_vector scripts;

The maximum length of a script name (stored as a putils::string) defaults to 64, and can be adjusted by defining the KENGINE_MAX_LUA_SCRIPT_PATH macro.

The maximum number of scripts defaults to 8 and can be adjusted by defining the KENGINE_MAX_LUA_SCRIPTS macro.