Game (functions)/Multiplayer
From PMDOWiki
More functions: Script Reference
This page documents the ScriptGame class for Lua scripting.
As a singleton class, it can be accessed from Lua with GAME.
EnterRescue
GAME:EnterRescue(sosPath)
Enters a zone and begins a rescue adventure.
Parameters
| Name | Type | Description |
|---|---|---|
| System.String | System.String | The path of the sos mail. |
Returns
| Type | Description |
|---|---|
| NLua.LuaFunction |
AddAOKRemark
GAME:AddAOKRemark(remarkIndex)
TODO: WIP
Parameters
| Name | Type | Description |
|---|---|---|
| System.Int32 | System.Int32 |
HasSOSMail
GAME:HasSOSMail()
TODO
Returns
| Type | Description |
|---|---|
| System.Boolean |
HasAOKMail
GAME:HasAOKMail()
TODO
Returns
| Type | Description |
|---|---|
| System.Boolean |
HasServerSet
GAME:HasServerSet()
Returns true if there is at least one server in the server list.
Returns
| Type | Description |
|---|---|
| System.Boolean |
GetRescueAllowed
GAME:GetRescueAllowed()
Checks to see if rescue is allowed.
Returns
| Type | Description |
|---|---|
| System.Boolean | True if rescues are allowed, false otherwise. |
SetRescueAllowed
GAME:SetRescueAllowed(allowed)
Sets the value in the player's save file to determine if they can be rescued or not.
If rescue is possible on the Save File level, it can still be prevented by the map.
Parameters
| Name | Type | Description |
|---|---|---|
| System.Boolean | System.Boolean | Set to true to allow the player to be rescued. False otherwise. |
References
https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Lua/ScriptGameMultiplayer.cs
