Class ScreenManager
ScreenManager singleton
Methods
| screenmanager:AddNewScreenToTop (string, sScreenName, string, sMessage) | Adds a screen at the top of the screen stack. |
| screenmanager:GetTopScreen () | Gets the screen at the top of the screen stack. |
| screenmanager:get_input_redirected (PlayerNumber, pn) | Returns whether the input for the player has been redirected away from the normal screen input function. |
| screenmanager:PlayInvalidSound () | Plays the invalid sound. |
| screenmanager:PlayStartSound () | Plays the start sound. |
| screenmanager:PlayCoinSound () | Plays the coin sound. |
| screenmanager:PlayCancelSound () | Plays the cancel sound. |
| screenmanager:PlayScreenshotSound () | Plays the screenshot sound. |
| screenmanager:ReloadOverlayScreens () | Reloads any loaded overlay screens. |
| screenmanager:ScreenClassExists (string, s) | Returns true if screen class s exists. |
| screenmanager:ScreenIsPrepped (string, s) | Returns true if screen s is prepared. |
| screenmanager:SetNewScreen (string, s) | Sets the next screen to s. |
| screenmanager:set_input_redirected (PlayerNumber, pn, bool, redir) | Sets whether the input for the player has been redirected away from the normal screen input function. |
| screenmanager:SystemMessage (string, s) | Broadcasts a system message. |
Methods
- screenmanager:AddNewScreenToTop (string, sScreenName, string, sMessage)
-
Adds a screen at the top of the screen stack. (
sMessageis an optional ScreenMessage posted once the new screen is finished.)Parameters:
- string
- sScreenName
- string
- sMessage
Returns:
-
void
- screenmanager:GetTopScreen ()
-
Gets the screen at the top of the screen stack.
Returns:
-
Screen
- screenmanager:get_input_redirected (PlayerNumber, pn)
-
Returns whether the input for the player has been redirected away from the normal screen input function. Input that has been redirected is only sent to lua input callbacks.
Parameters:
- PlayerNumber
- pn
Returns:
-
bool
- screenmanager:PlayInvalidSound ()
-
Plays the invalid sound.
Returns:
- screenmanager:PlayStartSound ()
-
Plays the start sound.
Returns:
- screenmanager:PlayCoinSound ()
-
Plays the coin sound.
Returns:
- screenmanager:PlayCancelSound ()
-
Plays the cancel sound.
Returns:
- screenmanager:PlayScreenshotSound ()
-
Plays the screenshot sound.
Returns:
- screenmanager:ReloadOverlayScreens ()
-
Reloads any loaded overlay screens.
Returns:
-
void
- screenmanager:ScreenClassExists (string, s)
-
Returns
trueif screen classsexists.Parameters:
- string
- s
Returns:
-
bool
- screenmanager:ScreenIsPrepped (string, s)
-
Returns
trueif screensis prepared.Parameters:
- string
- s
Returns:
-
bool
- screenmanager:SetNewScreen (string, s)
-
Sets the next screen to
s.Parameters:
- string
- s
Returns:
-
void
- screenmanager:set_input_redirected (PlayerNumber, pn, bool, redir)
-
Sets whether the input for the player has been redirected away from the normal screen input function. Input that has been redirected is only sent to lua input callbacks.
This can be useful when putting a custom menu on a screen, and you want to disable the built in actors while the menu is open. Then you handle input through an input callback until the player closes the menu.Parameters:
- PlayerNumber
- pn
- bool
- redir
Returns:
-
bool
- screenmanager:SystemMessage (string, s)
-
Broadcasts a system message.
Parameters:
- string
- s
Returns:
-
void