aom.scripting.ui.console

Class Mode

Object

Mode

public class Mode
extends Object

This class provides a collection of Console commands concerning Game Modes (not to be confused with edit modes). An (incomplete?) list of modes and submodes:

• Simulation
  • SinglePlayer
  • GameMenu
  • PostGame
  • Editor
  • ScenarioTest
  • RecordGame
  • Cinematic
  • CinematicBuild
  • HotKeySetup
  • Options
• PreGame / PreGameUI
  • HotKeySetup
  • Options
  • ModManager (Steam Workshop in AoM:EE)
• Campaign
• Arena
• SinglePlayerSetup
• ProfileSelect
• MPSession
  • Menu
  • QuickTeam
  • Broadcast
  • Receive
• RM Setup

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Local Call

Mode commands are all local.

See Also:

Console.editMode(string)

Method Summary

Modifier and Type	Method and Description
void	enterRecordGameMode(string name) Enter the mode used to play recorded games.
void	modeEnter(string mode) Enters the named mode.
void	subModeClear(string mode) Leaves all active submodes of the named mode.
void	subModeEnter(string mode, string subMode) Enters the named submode (of the main mode).
void	subModeLeave(string mode, string subMode) Leaves the named submode (of the main mode).
void	subModeToggle(string mode, string subMode) Changes the state of the named submode (of the main mode).
void	subModeToggleBetween(string mode, string subMode1, string subMode2) Toggles between the two submodes (of the main mode).
void	subModeToggleBetweenIfNotMP(string mode, string subMode1, string subMode2) Toggles between the two submodes (of the main mode), but only if we're not in a multiplayer game.
void	subModeToggleIfNotMP(string mode, string subMode) Changes the state of the named submode (of the main mode), but only if we're not in a multiplayer game.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

enterRecordGameMode

public void enterRecordGameMode(string name)

Enter the mode used to play recorded games. Don't expect this to work properly.

modeEnter

public void modeEnter(string mode)

Enters the named mode.

subModeEnter

public void subModeEnter(string mode,
                         string subMode)

Enters the named submode (of the main mode).

subModeLeave

public void subModeLeave(string mode,
                         string subMode)

Leaves the named submode (of the main mode).

subModeClear

public void subModeClear(string mode)

Leaves all active submodes of the named mode.

subModeToggle

public void subModeToggle(string mode,
                          string subMode)

Changes the state of the named submode (of the main mode).

subModeToggleIfNotMP

public void subModeToggleIfNotMP(string mode,
                                 string subMode)

Changes the state of the named submode (of the main mode), but only if we're not in a multiplayer game.

subModeToggleBetween

public void subModeToggleBetween(string mode,
                                 string subMode1,
                                 string subMode2)

Toggles between the two submodes (of the main mode).

subModeToggleBetweenIfNotMP

public void subModeToggleBetweenIfNotMP(string mode,
                                        string subMode1,
                                        string subMode2)

Toggles between the two submodes (of the main mode), but only if we're not in a multiplayer game.