Script Component Role Parameters

Detailed Description

Collaboration diagram for Script Component Role Parameters:

Variables
constexpr const char *	makVre::ScriptComponentConfig::script = "script"
constexpr const char *	makVre::ScriptComponentConfig::scriptConfig = "scriptConfig"

Variable Documentation

script

const char* makVre::ScriptComponentConfig::script = "script"

constexpr

Parameter Name	script
Parameter Description	Path to the Lua script file to load and execute.
Parameter Type	string
Parameter Default	N/A
Required?	Yes

Example Role Config Usage:

["scriptComponent"] = { 
   ... 
   script = "scripts/myScript.lua"; 
   ... 
};

scriptConfig

const char* makVre::ScriptComponentConfig::scriptConfig = "scriptConfig"

constexpr

Parameter Name	scriptConfig
Parameter Description	Configuration table to pass to the script's initialize function.
Parameter Type	table
Parameter Default	""
Required?	No

Example Role Config Usage:

["scriptComponent"] = { 
   ... 
   scriptConfig = ""; 
   ... 
};