Skyline Lua API  Version 1.0
Lua Script Reference for Skyline Game Engine.
LUA_API_Weapon.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 weapon
28 {
29 public:
40  int getEmptyClipVolume(String weaponName);
41 
52  int getReloadVolume(String weaponName);
53 
64  int getShootVolume(String weaponName);
65 
76  String getEmptyClipSoundFile(String weaponName);
77 
88  String getReloadSoundFile(String weaponName);
89 
100  String getShootSoundFile(String weaponName);
101 
112  float3 getRotate(String weaponName);
113 
124  float3 getOffset(String weaponName);
125 
136  float3 getOffsetTagPoint(String weaponName);
137 
148  String getMeshFile(String weaponName);
149 
160  float getDamage(String weaponName);
161 
172  float getRange(String weaponName);
173 
184  float getPower(String weaponName);
185 
196  int getMaxRounds(String weaponName);
197 
208  int getMaxClips(String weaponName);
209 
210 
221  int getUseSingleShot(String weaponName);
222 
233  float getAutoInterval(String weaponName);
234 
235 
246  String getReticleImageFile(String weaponName);
247 
248 
259  float getReloadTime(String weaponName);
260 
261 
272  float getMeleeTime(String weaponName);
273 
284  String getAnim(String weaponName, String AnimName);
285 
296  int getMuzzleParticleType(String weaponName);
297 
308  int getTracerParticleType(String weaponName);
309 
320  String getMuzzleFile(String weaponName);
321 
332  String getTracerFile(String weaponName);
333 
334 
335 
336 };
337 
float getAutoInterval(String weaponName)
Grab the time interval between each bullet in auto fire mode.
String getEmptyClipSoundFile(String weaponName)
Grab the weapons empty sound file name.
float3 getRotate(String weaponName)
Grab the weapons mesh rotational offset.
float getPower(String weaponName)
Grab the damage power, how hard the bullet will hit.
String getReloadSoundFile(String weaponName)
Grab the weapons reload sound file name.
Definition: LUA_API_Weapon.h:27
String getMeshFile(String weaponName)
Grab the weapons mesh filename.
float getMeleeTime(String weaponName)
Grab the time interval that this animation will run for .
int getReloadVolume(String weaponName)
Grab the reload sound volume.
int getTracerParticleType(String weaponName)
Grab the particle type either 0 = Sky particle or 1 = PU particle.
String getShootSoundFile(String weaponName)
Grab the weapons shoot sound file name.
int getMuzzleParticleType(String weaponName)
Grab the particle type either 0 = Sky particle or 1 = PU particle.
float3 getOffset(String weaponName)
Grab the weapons mesh offset data.
int getMaxClips(String weaponName)
Grab the max number of clips.
String getTracerFile(String weaponName)
Grab the particle file for the tracer effect.
String getAnim(String weaponName, String AnimName)
Grab the animation name set in the weapons editor for this item.
int getUseSingleShot(String weaponName)
Grab the shooting mode 1 = single shot 0 = auto.
int getShootVolume(String weaponName)
Grab the shoot sound volume.
int getEmptyClipVolume(String weaponName)
Grab the Empty Clip sound volume.
float getDamage(String weaponName)
Grab the damage amount of the bullet.
String getMuzzleFile(String weaponName)
Grab the particle file for the Muzzle effect.
int getMaxRounds(String weaponName)
Grab the max number of rounds.
float getReloadTime(String weaponName)
Grab the time interval that this animation will run for .
String getReticleImageFile(String weaponName)
Grab the image file name for the reticle .
float3 getOffsetTagPoint(String weaponName)
Grab the weapons effect tag point offset data.
float getRange(String weaponName)
Grab the damage range, how far the bullet will travel.