#include <LUA_API_Weapon.h>

Public Member Functions
int	getEmptyClipVolume (String weaponName)
	Grab the Empty Clip sound volume. More...

int	getReloadVolume (String weaponName)
	Grab the reload sound volume. More...

int	getShootVolume (String weaponName)
	Grab the shoot sound volume. More...

String	getEmptyClipSoundFile (String weaponName)
	Grab the weapons empty sound file name. More...

String	getReloadSoundFile (String weaponName)
	Grab the weapons reload sound file name. More...

String	getShootSoundFile (String weaponName)
	Grab the weapons shoot sound file name. More...

float3	getRotate (String weaponName)
	Grab the weapons mesh rotational offset. More...

float3	getOffset (String weaponName)
	Grab the weapons mesh offset data. More...

float3	getOffsetTagPoint (String weaponName)
	Grab the weapons effect tag point offset data. More...

String	getMeshFile (String weaponName)
	Grab the weapons mesh filename. More...

float	getDamage (String weaponName)
	Grab the damage amount of the bullet. More...

float	getRange (String weaponName)
	Grab the damage range, how far the bullet will travel. More...

float	getPower (String weaponName)
	Grab the damage power, how hard the bullet will hit. More...

int	getMaxRounds (String weaponName)
	Grab the max number of rounds. More...

int	getMaxClips (String weaponName)
	Grab the max number of clips. More...

int	getUseSingleShot (String weaponName)
	Grab the shooting mode 1 = single shot 0 = auto. More...

float	getAutoInterval (String weaponName)
	Grab the time interval between each bullet in auto fire mode. More...

String	getReticleImageFile (String weaponName)
	Grab the image file name for the reticle . More...

float	getReloadTime (String weaponName)
	Grab the time interval that this animation will run for . More...

float	getMeleeTime (String weaponName)
	Grab the time interval that this animation will run for . More...

String	getAnim (String weaponName, String AnimName)
	Grab the animation name set in the weapons editor for this item. More...

int	getMuzzleParticleType (String weaponName)
	Grab the particle type either 0 = Sky particle or 1 = PU particle. More...

int	getTracerParticleType (String weaponName)
	Grab the particle type either 0 = Sky particle or 1 = PU particle. More...

String	getMuzzleFile (String weaponName)
	Grab the particle file for the Muzzle effect. More...

String	getTracerFile (String weaponName)
	Grab the particle file for the tracer effect. More...

Detailed Description

This area covers weapons editor functions. Grab data for any weapon key which has been set up in the weapons editor.
Use as weapon.function()
For more information on how these functions can be used please visit the User Manual - https://home.aurasoft-skyline.co.uk

Member Function Documentation

String weapon::getAnim	(	String	weaponName,
		String	AnimName
	)

Grab the animation name set in the weapons editor for this item.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

animName = weapon.getAnim("scar", "shoot");

float weapon::getAutoInterval ( String weaponName )

Grab the time interval between each bullet in auto fire mode.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

interval = weapon.getAutoInterval("scar");

float weapon::getDamage ( String weaponName )

Grab the damage amount of the bullet.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

damage = weapon.getDamage("scar");

String weapon::getEmptyClipSoundFile ( String weaponName )

Grab the weapons empty sound file name.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

file = weapon.getEmptyClipSoundFile("scar");

int weapon::getEmptyClipVolume ( String weaponName )

Grab the Empty Clip sound volume.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

vol = weapon.getEmptyClipVolume("scar");

int weapon::getMaxClips ( String weaponName )

Grab the max number of clips.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

clips = weapon.getMaxClips("scar");

int weapon::getMaxRounds ( String weaponName )

Grab the max number of rounds.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

rounds = weapon.getMaxRounds("scar");

float weapon::getMeleeTime ( String weaponName )

Grab the time interval that this animation will run for .

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

interval = weapon.getMeleeTime("scar");

String weapon::getMeshFile ( String weaponName )

Grab the weapons mesh filename.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

meshFile = weapon.getMeshFile("scar");

String weapon::getMuzzleFile ( String weaponName )

Grab the particle file for the Muzzle effect.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

file = weapon.getMuzzleFile("scar");

int weapon::getMuzzleParticleType ( String weaponName )

Grab the particle type either 0 = Sky particle or 1 = PU particle.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

type = weapon.getMuzzleParticleType("scar");

float3 weapon::getOffset ( String weaponName )

Grab the weapons mesh offset data.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

x,y,z = weapon.getOffset("scar");

float3 weapon::getOffsetTagPoint ( String weaponName )

Grab the weapons effect tag point offset data.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

x,y,z = weapon.getOffsetTagPoint("scar");

float weapon::getPower ( String weaponName )

Grab the damage power, how hard the bullet will hit.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

power = weapon.getPower("scar");

float weapon::getRange ( String weaponName )

Grab the damage range, how far the bullet will travel.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

range = weapon.getRange("scar");

String weapon::getReloadSoundFile ( String weaponName )

Grab the weapons reload sound file name.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

file = weapon.getReloadSoundFile("scar");

float weapon::getReloadTime ( String weaponName )

Grab the time interval that this animation will run for .

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

interval = weapon.getReloadTime("scar");

int weapon::getReloadVolume ( String weaponName )

Grab the reload sound volume.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

vol = weapon.getReloadVolume("scar");

String weapon::getReticleImageFile ( String weaponName )

Grab the image file name for the reticle .

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

imageFile = weapon.getReticleImageFile("scar");

float3 weapon::getRotate ( String weaponName )

Grab the weapons mesh rotational offset.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

rx,ry,rz = weapon.getRotate("scar");

String weapon::getShootSoundFile ( String weaponName )

Grab the weapons shoot sound file name.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

file = weapon.getShootSoundFile("scar");

int weapon::getShootVolume ( String weaponName )

Grab the shoot sound volume.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

vol = weapon.getShootVolume("scar");

String weapon::getTracerFile ( String weaponName )

Grab the particle file for the tracer effect.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

file = weapon.getTracerFile("scar");

int weapon::getTracerParticleType ( String weaponName )

Grab the particle type either 0 = Sky particle or 1 = PU particle.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

type = weapon.getTracerParticleType("scar");

int weapon::getUseSingleShot ( String weaponName )

Grab the shooting mode 1 = single shot 0 = auto.

Parameters

key	: The name of the weapon item from the weapons editor eg "scar"

Returns: value :value set in the weapons editor for this "weapon key name"

The following is a Small Example on how to use this function:

mode = weapon.getAutoInterval("scar");

The documentation for this class was generated from the following file:

LUA_API_Weapon.h

Public Member Functions

Detailed Description

Member Function Documentation