Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-05-08 03:28:03 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Rename some of GameScriptLevel's Lua "members" to better reflect their purpose.

Browse source 
Add documentation that was missing.
This commit is contained in:
hispidence 2021-08-09 20:02:55 +01:00
parent 0c58e78733
commit c21f2ac829
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

30
TR5Main/Scripting/GameScriptLevel.cpp
View file

@ -15,23 +15,23 @@ void GameScriptLevel::Register(sol::state* state)
state->new_usertype<GameScriptLevel>("Level", state->new_usertype<GameScriptLevel>("Level",
sol::constructors<GameScriptLevel()>(), sol::constructors<GameScriptLevel()>(),
/// (string) todo /// (string) string key for the level's (localised) name. Corresponds to an entry in strings.lua.
//@mem name //@mem nameKey
"name", &GameScriptLevel::NameStringKey, "nameKey", &GameScriptLevel::NameStringKey,
/// (string) todo /// (string) path of the Lua file holding the level's logic script, relative to the location of the tombengine executable
//@mem script //@mem scriptFile
"script", &GameScriptLevel::ScriptFileName, "scriptFile", &GameScriptLevel::ScriptFileName,
/// (string) todo /// (string) path of the compiled level file, relative to the location of the tombengine executable
//@mem fileName //@mem levelFile
"fileName", &GameScriptLevel::FileName, "levelFile", &GameScriptLevel::FileName,
/// (string) todo /// (string) path of the level's load screen file (.png or .jpg), relative to the location of the tombengine executable
//@mem loadScreen //@mem loadScreenFile
"loadScreen", &GameScriptLevel::LoadScreenFileName, "loadScreenFile", &GameScriptLevel::LoadScreenFileName,
/// (string) todo /// (string) initial ambient sound track to play - this is the filename of the track __without__ the .wav extension
//@mem ambientTrack //@mem ambientTrack
"ambientTrack", &GameScriptLevel::AmbientTrack, "ambientTrack", &GameScriptLevel::AmbientTrack,
@ -96,8 +96,8 @@ e.g. `myLevel.laraType = LaraType.DIVESUIT`
//@mem mirror //@mem mirror
"mirror", &GameScriptLevel::Mirror, "mirror", &GameScriptLevel::Mirror,
/// (table of InventoryObjects) todo /// (table of InventoryObjects) table of inventory object overrides
//@mem mirror //@mem objects
"objects", &GameScriptLevel::InventoryObjects "objects", &GameScriptLevel::InventoryObjects
); );
} }