API:LeaveScenarioGroup

UI Lua API · Scenario functions
Version: WAR 1.4.8

Asks the server to remove the player from their scenario group.

LeaveScenarioGroup()

Arguments

None.

Returns

Nothing.

Details

• Nothing is sent if there is no player object, or if the player is neither in a scenario (GameData.Player.isInScenario) nor in a city siege (GameData.Player.isInSiege).
• Arguments are not read.

Errors

None.

Example

From default/ea_scenariogroupwindow/source/scenariogroupwindow.lua:

function ScenarioGroupWindow.LeaveGroup()
    LeaveScenarioGroup()
    ScenarioGroupWindow.GroupJoined = 0
    ScenarioGroupWindow.HideLeaveGroupElements()
end

See also

• JoinScenarioGroup