Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
LUA_API_States.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2017 http://www.aurasoft.co.uk
8 // |
9 // | Skyline Game Engine Lua API Documentation
10 // |
11 // | This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
12 // | This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other
13 // | person outside of the Skyline Game Engine development team.
14 // |
15 // | Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2017
16 // |
17 
18 // SKYLINE LUA CLASS FOR API DOCUMENTATION
19 
28 class state
29 {
30 public:
31 
68  void setGameState(int stateID);
69 
82  int getGameState();
83 
96  void setGamePaused();
97 
111  void setGameMain();
112 
125  void setGameStart();
126 
139  void setGameOver();
140 
153  void setGameWin();
154 
167  void setGameUser1();
168 
181  void setGameUser2();
182 
195  void setGameUser3();
196 
209  void setGameUser4();
210 
223  void setGameUser5();
224 
237  void setGameUser6();
238 
251  void setGameUser7();
252 
265  void setGameUser8();
266 
279  void setGameUser9();
280 
293  void setGameUser10();
294 
348  void routeStatePath(int stateID);
349 
350 
351 };
void setGameUser10()
Call this function to set the current game state to User State 10. No params required.
void setGameUser3()
Call this function to set the current game state to User State 3. No params required.
void setGamePaused()
Call this function to set the current game state to Paused. No params required.
void setGameUser5()
Call this function to set the current game state to User State 5. No params required.
void setGameStart()
Call this function to set the current game state to Game Start. No params required.
void setGameUser7()
Call this function to set the current game state to User State 7. No params required.
void routeStatePath(int stateID)
Reroute how the user states update during the game. This is useful if you want the game to freeze in ...
void setGameOver()
Call this function to set the current game state to Game Over. No params required.
void setGameUser6()
Call this function to set the current game state to User State 6. No params required.
void setGameMain()
Call this function to set the current game state to Main state which is default. No params required...
void setGameUser4()
Call this function to set the current game state to User State 4. No params required.
void setGameUser1()
Call this function to set the current game state to User State 1. No params required.
void setGameWin()
Call this function to set the current game state to GameWin. No params required.
Definition: LUA_API_States.h:28
int getGameState()
Call this function to return the current Game State.
void setGameUser9()
Call this function to set the current game state to User State 9. No params required.
void setGameUser8()
Call this function to set the current game state to User State 8. No params required.
void setGameUser2()
Call this function to set the current game state to User State 2. No params required.
void setGameState(int stateID)
Set the current game state in the game. This means swap between the predefined states such as Main ga...