Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
LUA_API_FpsSystem.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2016 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 - 2016
16 // |
17 
18 // SKYLINE LUA CLASS FOR API DOCUMENTATION
19 
29 class fpsSystem
30 {
31 public:
32 
55  void setHasAmmo(int entity_ID, int state);
56 
57 
58 
85  void playReloadSound(int entity_ID);
86 
87 //=========================================
103  int getMaxClips(string wKey);
104 
120  int getMaxAmmo(string wKey);
121 
136  void setWeapon(int entityID, string wKey);
137 
153  String getWeapon(int entityID);
154 
155 
168  void setKO(int entityID, int state);
169 
170 
186  void setPosition(int entityID, float x, float y, float z);
187 
200  void setPositionString(int entityID, String xyz);
201 
214  void damagePlayer(int entityID, float damageAmt);
215 
228  void setAsPlayer(int entityID, int state);
229 };
void playReloadSound(int entity_ID)
Play the current weapons reload sound.
String getWeapon(int entityID)
Returns the weapon key of the Game Systems current weapon.
void setPositionString(int entityID, String xyz)
Sets the player position .
void setWeapon(int entityID, string wKey)
Set the Game Systems main weapon to the type passed in the arg.
void damagePlayer(int entityID, float damageAmt)
Triggers player damage event in the fps player micro script where the arg damageAmt is passed through...
Definition: LUA_API_States.h:28
void setHasAmmo(int entity_ID, int state)
Set the FPS Systems hasAmmo value. This value is used to notify the system that a weapon has ammo or ...
Definition: LUA_API_FpsSystem.h:29
int getMaxClips(string wKey)
Returns the max clip value for the weapon passed in the arg wKey.
int getMaxAmmo(string wKey)
Returns the max Ammo value for the weapon passed in the arg wKey.
void setAsPlayer(int entityID, int state)
Sets the character as the active player.
void setKO(int entityID, int state)
Sets the player KO status.
void setPosition(int entityID, float x, float y, float z)
Sets the player position .