nlua_munition.c File Reference

Handles the Lua munition bindings. More...

#include "nlua_munition.h"
#include "array.h"
#include "nlua.h"
#include "nluadef.h"
#include "nlua_faction.h"
#include "nlua_outfit.h"
#include "nlua_vec2.h"
#include "nlua_pilot.h"

Go to the source code of this file.

Functions
static Weapon *	munition_get (LuaMunition *lm)
static int	munitionL_eq (lua_State *L)
	Checks to see if munition and p are the same.
static int	munitionL_tostring (lua_State *L)
	Gets the munition's current (translated) name or notes it is inexistent.
static int	munitionL_exists (lua_State *L)
	Checks to see if a munition still exists.
static int	munitionL_clear (lua_State *L)
	Clears all the munitions in the system.
static int	munitionL_getAll (lua_State *L)
	Gets all the munitions in the system.
static int	munitionL_getInrange (lua_State *L)
	Get munitions in range. Note that this can only get hittable munitions.
static int	munitionL_pos (lua_State *L)
	Gets the position of the munition.
static int	munitionL_vel (lua_State *L)
	Gets the velocity of the munition.
static int	munitionL_faction (lua_State *L)
	Gets the faction of the munition.
static int	munitionL_parent (lua_State *L)
	Gets the parent of the munition.
static int	munitionL_target (lua_State *L)
	Gets the target of the munition.
static int	munitionL_outfit (lua_State *L)
	Gets the outfit corresponding to the munition.
static int	munitionL_strength (lua_State *L)
	Gets the strength of a munition.
static int	munitionL_strengthSet (lua_State *L)
	Sets the strength of a munition.
int	nlua_loadMunition (nlua_env env)
	Loads the munition library.
LuaMunition *	lua_tomunition (lua_State *L, int ind)
	Lua bindings to interact with munitions.
LuaMunition *	luaL_checkmunition (lua_State *L, int ind)
	Gets munition at index or raises error if there is no munition at index.
Weapon *	luaL_validmunition (lua_State *L, int ind)
	Makes sure the munition is valid or raises a Lua error.
LuaMunition *	lua_pushmunition (lua_State *L, const Weapon *w)
	Pushes a weapon as a munition on the stack.
int	lua_ismunition (lua_State *L, int ind)
	Checks to see if ind is a munition.
static int	weapon_isHostile (const Weapon *w, const Pilot *p)

Variables
static const luaL_Reg	munitionL_methods []

Detailed Description

Handles the Lua munition bindings.

These bindings control the spobs and systems.

Definition in file nlua_munition.c.

Function Documentation

lua_ismunition()

int lua_ismunition	(	lua_State *	L,
		int	ind )

Checks to see if ind is a munition.

Parameters

L	Lua state to check.
ind	Index position to check.

Returns

1 if ind is a munition.

Definition at line 153 of file nlua_munition.c.

lua_pushmunition()

LuaMunition * lua_pushmunition	(	lua_State *	L,
		const Weapon *	w )

Pushes a weapon as a munition on the stack.

Parameters

L	Lua state to push munition into.
w	Weapon to push as munition.

Returns

Newly pushed munition.

Definition at line 136 of file nlua_munition.c.

lua_tomunition()

LuaMunition * lua_tomunition	(	lua_State *	L,
		int	ind )

Lua bindings to interact with munitions.

This will allow you to create and manipulate munitions in-game.

Lua module: munition

Gets munition at index.

Parameters

L	Lua state to get munition from.
ind	Index position to find the munition.

Returns

Munition found at the index in the state.

Definition at line 95 of file nlua_munition.c.

luaL_checkmunition()

LuaMunition * luaL_checkmunition	(	lua_State *	L,
		int	ind )

Gets munition at index or raises error if there is no munition at index.

Parameters

L	Lua state to get munition from.
ind	Index position to find munition.

Returns

Munition found at the index in the state.

Definition at line 106 of file nlua_munition.c.

luaL_validmunition()

Weapon * luaL_validmunition	(	lua_State *	L,
		int	ind )

Makes sure the munition is valid or raises a Lua error.

Parameters

L	State currently running.
ind	Index of the munition to validate.

Returns

The munition (doesn't return if fails - raises Lua error ).

Definition at line 120 of file nlua_munition.c.

munition_get()

static Weapon * munition_get ( LuaMunition * lm )

static

Definition at line 187 of file nlua_munition.c.

munitionL_clear()

static int munitionL_clear ( lua_State * L )

static

Clears all the munitions in the system.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: clear

Definition at line 241 of file nlua_munition.c.

munitionL_eq()

static int munitionL_eq ( lua_State * L )

static

Checks to see if munition and p are the same.

Lua usage parameter: if p == p2 then – Munition 'p' and 'p2' match.

Lua function parameter: Munition p Munition to compare. Lua function parameter: Munition comp Munition to compare against. Lua return parameter: boolean true if they are the same.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: __eq

Definition at line 179 of file nlua_munition.c.

munitionL_exists()

static int munitionL_exists ( lua_State * L )

static

Checks to see if a munition still exists.

Lua function parameter: Munition m Munition to see if still exists. Lua return parameter: boolean true if the munition still exists.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: exists

Definition at line 229 of file nlua_munition.c.

munitionL_faction()

static int munitionL_faction ( lua_State * L )

static

Gets the faction of the munition.

Lua function parameter: Munition m Munition to get property of. Lua return parameter: Faction Faction of the munition.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: faction

Definition at line 372 of file nlua_munition.c.

munitionL_getAll()

static int munitionL_getAll ( lua_State * L )

static

Gets all the munitions in the system.

Lua function parameter: boolean onlyhittable Whether or not to only get hittable munitions, or all of them. Lua return parameter: table A table containing all the munitions in the system.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: getAll

Definition at line 255 of file nlua_munition.c.

munitionL_getInrange()

static int munitionL_getInrange ( lua_State * L )

static

Get munitions in range. Note that this can only get hittable munitions.

Lua function parameter: Vec2 pos Position from which to get munitions. Lua function parameter: number range Range to get munitions from. Lua function parameter:[opt=nil] Pilot|nil Pilot to check hostility to. Lua return parameter: table A table containing all the munitions found in range.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: getInrange

Definition at line 306 of file nlua_munition.c.

munitionL_outfit()

static int munitionL_outfit ( lua_State * L )

static

Gets the outfit corresponding to the munition.

Lua function parameter: Munition m Munition to get corresponding outfit of. Lua return parameter: Outfit The outfit corresponding to the munition.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: outfit

Definition at line 414 of file nlua_munition.c.

munitionL_parent()

static int munitionL_parent ( lua_State * L )

static

Gets the parent of the munition.

Lua function parameter: Munition m Munition to get property of. Lua return parameter: Pilot Parent of the munition.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: parent

Definition at line 386 of file nlua_munition.c.

munitionL_pos()

static int munitionL_pos ( lua_State * L )

static

Gets the position of the munition.

Lua function parameter: Munition m Munition to get property of. Lua return parameter: Vec2 Position of the munition.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: pos

Definition at line 344 of file nlua_munition.c.

munitionL_strength()

static int munitionL_strength ( lua_State * L )

static

Gets the strength of a munition.

Defaults to 1. and only changed when past falloff range or modified by a Lua script.

Lua function parameter: Munition m Munition to get strength of. Lua return parameter: number The corresponding strength value where 1 indicates normal strength.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: strength

See also

strengthSet

Definition at line 431 of file nlua_munition.c.

munitionL_strengthSet()

static int munitionL_strengthSet ( lua_State * L )

static

Sets the strength of a munition.

Lua function parameter: Munition m Munition to get strength of. Lua function parameter: number str Strength to set to. A value of 1 indicates normal strength.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: strengthSet

See also

strength

Definition at line 446 of file nlua_munition.c.

munitionL_target()

static int munitionL_target ( lua_State * L )

static

Gets the target of the munition.

Lua function parameter: Munition m Munition to get property of. Lua return parameter: Pilot Target of the munition.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: target

Definition at line 400 of file nlua_munition.c.

munitionL_tostring()

static int munitionL_tostring ( lua_State * L )

static

Gets the munition's current (translated) name or notes it is inexistent.

Lua usage parameter: tostring(p)

Lua function parameter: Munition p Munition to convert to string. Lua return parameter: string The current name of the munition or "(inexistent munition)" if not existent.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: __tostring

Definition at line 211 of file nlua_munition.c.

munitionL_vel()

static int munitionL_vel ( lua_State * L )

static

Gets the velocity of the munition.

Lua function parameter: Munition m Munition to get property of. Lua return parameter: Vec2 Velocity of the munition.

Parameters

L

Lua State

Returns

Number of variables on the Lua State stack.

Lua function: vel

Definition at line 358 of file nlua_munition.c.

nlua_loadMunition()

int nlua_loadMunition

(

nlua_env

env

)

Loads the munition library.

Parameters

env	Environment to load library into.

Returns

0 on success.

Definition at line 71 of file nlua_munition.c.

weapon_isHostile()

static int weapon_isHostile ( const Weapon * w, const Pilot * p )

static

Definition at line 273 of file nlua_munition.c.

Variable Documentation

munitionL_methods

const luaL_Reg munitionL_methods[]

static

Initial value:

= {
   
   { "__eq", munitionL_eq },
   { "__tostring", munitionL_tostring },
   { "exists", munitionL_exists },
   { "clear", munitionL_clear },
   { "getAll", munitionL_getAll },
   { "getInrange", munitionL_getInrange },
   
   { "pos", munitionL_pos },
   { "vel", munitionL_vel },
   { "faction", munitionL_faction },
   { "parent", munitionL_parent },
   { "target", munitionL_target },
   { "outfit", munitionL_outfit },
   { "strength", munitionL_strength },
   
   { "strengthSet", munitionL_strengthSet },
   
   {0,0},
}

Munition metatable methods.

Definition at line 43 of file nlua_munition.c.