Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-04-30 00:37:58 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix some GameLogic documentation.

Browse source
This commit is contained in:
hispidence 2021-08-12 20:14:40 +01:00
parent c8de277d44
commit adcee07c68
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
TR5Main/Scripting/GameLogicScript.cpp
View file

@ -236,7 +236,7 @@ or is destroyed in some other way.
Get an ItemInfo by its name.
@function GetItemByName
@tparam string name the unique name of the item as set in, or generated by, Tomb Editor
@return a non-owning ItemInfo referencing the item.
@treturn ItemInfo a non-owning ItemInfo referencing the item.
*/
m_lua->set_function("GetItemByName", &GameScript::GetItemByName, this);
@ -244,7 +244,7 @@ Get an ItemInfo by its name.
Get a MeshInfo by its name.
@function GetMeshByName
@tparam string name the unique name of the mesh as set in, or generated by, Tomb Editor
@return a non-owning MeshInfo referencing the mesh.
@treturn MeshInfo a non-owning MeshInfo referencing the mesh.
*/
m_lua->set_function("GetMeshByName", &GameScript::GetMeshByName, this);
@ -252,7 +252,7 @@ Get a MeshInfo by its name.
Get a CameraInfo by its name.
@function GetCameraByName
@tparam string name the unique name of the camera as set in, or generated by, Tomb Editor
@return a non-owning CameraInfo referencing the camera.
@treturn CameraInfo a non-owning CameraInfo referencing the camera.
*/
m_lua->set_function("GetCameraByName", &GameScript::GetCameraByName, this);
@ -260,7 +260,7 @@ Get a CameraInfo by its name.
Get a SinkInfo by its name.
@function GetSinkByName
@tparam string name the unique name of the sink as set in, or generated by, Tomb Editor
@return a non-owning CameraInfo referencing the sink.
@treturn SinkInfo a non-owning SinkInfo referencing the sink.
*/
m_lua->set_function("GetSinkByName", &GameScript::GetSinkByName, this);
@ -786,7 +786,8 @@ you can just leave out `LevelFuncs.OnStart`.
@tfield function OnStart Will be called when a level is loaded
@tfield function OnLoad Will be called when a saved game is loaded
@tfield function OnControlPhase Will be called once per frame
@tfield function(float) OnControlPhase Will be called during the game's update loop,
and provides the delta time (a float representing game time since last call) via its argument.
@tfield function OnSave Will be called when the player saves the game
@tfield function OnEnd Will be called when leaving a level. This includes finishing it, exiting to the menu, or loading a save in a different level.
@table LevelFuncs