Update Level documentation.

This commit is contained in:
hispidence 2021-08-11 14:50:10 +01:00
parent 55e7de24b8
commit 94c6ada241

View file

@ -10,6 +10,10 @@ level file itself.
@pragma nostrip @pragma nostrip
*/ */
/*** Make a new Level object.
@function Level.new
@return a Level object
*/
void GameScriptLevel::Register(sol::state* state) void GameScriptLevel::Register(sol::state* state)
{ {
state->new_usertype<GameScriptLevel>("Level", state->new_usertype<GameScriptLevel>("Level",
@ -91,12 +95,12 @@ e.g. `myLevel.laraType = LaraType.DIVESUIT`
//@mem rumble //@mem rumble
"rumble", &GameScriptLevel::Rumble, "rumble", &GameScriptLevel::Rumble,
/// (Mirror) object holding the location and size of the room's mirror, if present. /// (@{Mirror}) object holding the location and size of the room's mirror, if present.
// __(not yet implemented)__ // __(not yet implemented)__
//@mem mirror //@mem mirror
"mirror", &GameScriptLevel::Mirror, "mirror", &GameScriptLevel::Mirror,
/// (table of InventoryObjects) table of inventory object overrides /// (table of @{InventoryObject}s) table of inventory object overrides
//@mem objects //@mem objects
"objects", &GameScriptLevel::InventoryObjects "objects", &GameScriptLevel::InventoryObjects
); );