Skyline Lua API  Version 1.0
Lua Script Reference for Skyline Game Engine.
LUA_API_Game.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2018 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 - 2018
16 // |
17 
18 // SKYLINE LUA CLASS FOR API DOCUMENTATION
19 
27 class game
28 {
29 public:
30 
44  void getPlayerID();
45 
61  void setPlayerID(string tagName);
62 
83  void clickObject(int Zero);
84 
99  void resetLevel(int zero);
100 
119  void enableMouseRay(int state);
120 
135  void setMouseTrap(int state);
136 
137 
138 
151  void doDamage(int entityID, float x, float y, float z, float damageAmt, float powerAmt);
152 
153 
169  void shoot(int entityID, int state);
170 
181  void setWeaponFullAmmo(int entityID, string weapon, int state);
182 
194  void setTargetID(int entityID, int TargetID int enabled, float offsetY);
195 
196 
209  void setSceneSpeed( float speed );
210 
222  void setHealth(int objID, int health);
223 
234  int getHealth(int objID);
235 
247  void setWeapon(int entityID, String weaponKey);
248 
262  int resetGame(int mode);
263 
264 
265 
278  int SetMouseRayEnable(int state)
279 
280 
295  int isKo(int objID, int state)
296 };
int SetMouseRayEnable(int state) int isKo(int objID
Mouse ray on button down.
void setHealth(int objID, int health)
Set the health of a Entity with the damage action attached.
void setWeaponFullAmmo(int entityID, string weapon, int state)
sets the weapon shoot action to either behave as full ammo (state = 1) or no ammo (state = 0 ) ...
void setMouseTrap(int state)
Activates the system mouse trap. This provides screen mouse trap with wrapping.
void doDamage(int entityID, float x, float y, float z, float damageAmt, float powerAmt)
Causes damage to any object with an attached "Damage System" action.
Definition: LUA_API_Weapon.h:27
void setTargetID(int entityID, int TargetID int enabled, float offsetY)
When called this command will set the weapons action to target at the specified objects axis...
void shoot(int entityID, int state)
Triggers the shoot event in the object "Weapon - Shoot" action.
void setPlayerID(string tagName)
Override the default playerID with one derived from a custom user player tag name.
int getHealth(int objID)
Inspect a enitiy's health that has the damage action applied.
void setSceneSpeed(float speed)
Sets the speed of the scene.
Definition: LUA_API_States.h:28
Definition: LUA_API_Game.h:27
void setWeapon(int entityID, String weaponKey)
sets the weapon system current weapon.
void resetLevel(int zero)
Resets the game to the pre-play state whilst still in play the game mode.
void getPlayerID()
Returns the player ID from the default tag name of "Player".
void enableMouseRay(int state)
Activates the system mouse click ray which when hits an object will trigger the objects onClick event...
int resetGame(int mode)
Resets the full game without unloading resources.
void clickObject(int Zero)
Fires a ray into the scene and if it hits an entity, the entities script onClick event is fired...