LuaDocs/ActivityManager

From Data Realms Wiki

(Difference between revisions)
Jump to: navigation, search
LuaBot (Talk | contribs)
(ActivityManager - Automatically generated by LuaBot)

Latest revision as of 08:57, 15 May 2014

Contents

Has no parent class

Generic Class. The singleton manager of the Activity:s and rules of Cortex Command

Go back to Class Index


Properties

DefaultActivityType

The type name of the default activity to be loaded if nothing else is available.The default activity type name.

DefaultActivityName

The name of the default activity to be loaded if nothing else is available.The default activity instance name.


Functions

SetStartActivity

Sets a new activity to copy for next restart. You have to use RestartActivity to get it going. Ownership IS transferred!

Arguments:

  • The new activity to put into effect next time ResetActivity is called.

Return value:

None.


GetStartActivity

Gets the activity set to use a copy of for next restart. Ownership is NOT transferred!

Arguments:

  • None.

Return value:

The activity to put into effect next time ResetActivity is called. OINT!


GetActivity

Gets the current activity in effect. Won't be what has been set by SetStartActivity unless RestartActivity has been called since.

Arguments:

  • None.

Return value:

The current Activity in effect. Will be 0 if no activity is going.


RestartActivity

Completely restarts whatever activity was last started.

Arguments:

  • None.

Return value:

An error return value signaling sucess or any particular failure. Anything below 0 is an error signal.


PauseActivity

Pauses and unpauses the game.

Arguments:

  • Whether to pause the game or not.

Return value:

None.


EndActivity

Forces the current game's end.

Arguments:

  • None.

Return value:

None.


ActivityRunning

Indicates whether the game is currently running or not (not editing, over or paused)

Arguments:

  • None.

Return value:

Whether the game is running or not.


ActivityPaused

Indicates whether the game is currently paused or not.

Arguments:

  • None.

Return value:

Whether the game is paused or not.


Go back to Class Index

Personal tools