Ground (functions)/Misc
This page documents the ScriptGround class for Lua scripting.
As a singleton class, it can be accessed from Lua with GROUND.
HandoutEXP
GROUND:HandoutEXP(character, numLevelUps)
Gives a character a set amount of EXP.
Also handles leveling up and learning new moves.
Parameters
| Name | Type | Description |
|---|---|---|
| RogueEssence.Dungeon.Character | RogueEssence.Dungeon.Character | The characters to level up. |
| System.Int32 | System.Int32 | The number of level ups. |
Returns
| Type | Description |
|---|---|
| NLua.LuaFunction |
LevelUpChar
GROUND.LevelUpChar
Type: NLua.LuaFunction
Levels up a character a certain amount of times all at once.
Also handles learning new moves.
AddMapStatus
GROUND:AddMapStatus(statusIdx)
Adds a mapstatus to the ground map. Map statuses only have an aesthetic effect in ground maps.
Parameters
| Name | Type | Description |
|---|---|---|
| System.String | System.String | The ID of the Map Status |
RemoveMapStatus
GROUND:RemoveMapStatus(statusIdx)
Removes a map status from the ground map.
Parameters
| Name | Type | Description |
|---|---|---|
| System.String | System.String | The ID of the Map Status to remove. |
SetupLuaFunctions
GROUND:SetupLuaFunctions(state)
Initializes any LuaFunctions found in the class.
Automatically on lua initialization.
Parameters
| Name | Type | Description |
|---|---|---|
| RogueEssence.Script.LuaEngine | RogueEssence.Script.LuaEngine | The lua engine to initialize with. |
References
https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Lua/ScriptGroundMisc.cs
