escort.c File Reference

Handles the player's escorts. More...

#include "escort.h"
#include "array.h"
#include "dialogue.h"
#include "hook.h"
#include "log.h"
#include "nlua.h"
#include "nluadef.h"
#include "nstring.h"
#include "player.h"

Go to the source code of this file.

Functions
static int	escort_command (Pilot *parent, const char *cmd, unsigned int idx)
	Runs an escort command on all of a pilot's escorts. More...
int	escort_addList (Pilot *p, const char *ship, EscortType_t type, unsigned int id, int persist)
	Adds an escort to the escort list of a pilot. More...
void	escort_freeList (Pilot *p)
	Remove all escorts from a pilot. More...
void	escort_rmListIndex (Pilot *p, int i)
	Remove from escorts list. More...
void	escort_rmList (Pilot *p, unsigned int id)
	Remove from escorts list. More...
unsigned int	escort_create (Pilot *p, const char *ship, const vec2 *pos, const vec2 *vel, double dir, EscortType_t type, int add, int dockslot)
	Creates an escort. More...
unsigned int	escort_createRef (Pilot *p, Pilot *pe, const vec2 *pos, const vec2 *vel, double dir, EscortType_t type, int add, int dockslot)
	Creates an escort from a reference. More...
int	escort_clearDeployed (Pilot *p)
	Clears deployed escorts of a pilot. More...
int	escorts_attack (Pilot *parent)
	Have a pilot order its escorts to attack its target. More...
int	escorts_hold (Pilot *parent)
	Have a pilot order its escorts to hold position. More...
int	escorts_return (Pilot *parent)
	Have a pilot order its escorts to dock. More...
int	escorts_clear (Pilot *parent)
	Have a pilot order its escorts to clear orders. More...
int	escort_playerCommand (Pilot *e)
	Open a dialog for the player to issue a command to an escort. More...
int	escorts_jump (Pilot *parent, JumpPoint *jp)
	Have a pilot order its escorts to jump. More...

Detailed Description

Handles the player's escorts.

Definition in file escort.c.

Function Documentation

escort_addList()

int escort_addList	(	Pilot *	p,
		const char *	ship,
		EscortType_t	type,
		unsigned int	id,
		int	persist
	)

Adds an escort to the escort list of a pilot.

Parameters

p	Pilot to add escort to.
ship	Ship of the escort.
type	Type of the escort.
id	ID of the pilot representing the escort.
persist	True if escort should respawn on takeoff/landing.

Returns

0 on success.

Definition at line 40 of file escort.c.

escort_clearDeployed()

int escort_clearDeployed

(

Pilot *

p

)

Clears deployed escorts of a pilot.

Definition at line 229 of file escort.c.

escort_command()

static int escort_command ( Pilot *  parent, const char *  cmd, unsigned int  idx  )

static

Runs an escort command on all of a pilot's escorts.

Parameters

parent	Pilot who is giving orders.
cmd	Order to give.
idx	Lua index of argument or 0.

Returns

0 on success, 1 if no orders given.

Definition at line 263 of file escort.c.

escort_create()

unsigned int escort_create	(	Pilot *	p,
		const char *	ship,
		const vec2 *	pos,
		const vec2 *	vel,
		double	dir,
		EscortType_t	type,
		int	add,
		int	dockslot
	)

Creates an escort.

Parameters

p	Parent of the escort (who he's guarding).
ship	Name of the ship escort should have.
pos	Position to create escort at.
vel	Velocity to create escort with.
dir	Direction to face.
type	Type of escort.
add	Whether or not to add it to the escort list.
dockslot	The outfit slot which launched the escort (-1 if N/A)

Returns

The ID of the escort on success.

Definition at line 111 of file escort.c.

escort_createRef()

unsigned int escort_createRef	(	Pilot *	p,
		Pilot *	pe,
		const vec2 *	pos,
		const vec2 *	vel,
		double	dir,
		EscortType_t	type,
		int	add,
		int	dockslot
	)

Creates an escort from a reference.

Parameters

p	Parent of the escort (who he's guarding).
pe	Reference for the escort.
pos	Position to create escort at.
vel	Velocity to create escort with.
dir	Direction to face.
type	Type of escort.
add	Whether or not to add it to the escort list.
dockslot	The outfit slot which launched the escort (-1 if N/A)

Returns

The ID of the escort on success.

Definition at line 187 of file escort.c.

escort_freeList()

void escort_freeList

(

Pilot *

p

)

Remove all escorts from a pilot.

Parameters

p	Pilot to remove escorts from.

Definition at line 60 of file escort.c.

escort_playerCommand()

int escort_playerCommand

(

Pilot *

e

)

Open a dialog for the player to issue a command to an escort.

Parameters

e	The pilot for the player to issue an order to.

Returns

0 on success, 1 if no orders given.

Definition at line 357 of file escort.c.

escort_rmList()

void escort_rmList	(	Pilot *	p,
		unsigned int	id
	)

Remove from escorts list.

Parameters

p	Pilot to remove escort from.
id	ID of the pilot representing the escort.

Definition at line 88 of file escort.c.

escort_rmListIndex()

void escort_rmListIndex	(	Pilot *	p,
		int	i
	)

Remove from escorts list.

Parameters

p	Pilot to remove escort from.
i	index of the pilot representing the escort.

Definition at line 75 of file escort.c.

escorts_attack()

int escorts_attack

(

Pilot *

parent

)

Have a pilot order its escorts to attack its target.

Parameters

parent

Pilot giving the order.

Definition at line 284 of file escort.c.

escorts_clear()

int escorts_clear

(

Pilot *

parent

)

Have a pilot order its escorts to clear orders.

Parameters

parent

Pilot giving the order.

Definition at line 343 of file escort.c.

escorts_hold()

int escorts_hold

(

Pilot *

parent

)

Have a pilot order its escorts to hold position.

Parameters

parent

Pilot giving the order.

Definition at line 317 of file escort.c.

escorts_jump()

int escorts_jump	(	Pilot *	parent,
		JumpPoint *	jp
	)

Have a pilot order its escorts to jump.

Parameters

parent	Pilot giving the order.
jp	Where to jump.

Definition at line 409 of file escort.c.

escorts_return()

int escorts_return

(

Pilot *

parent

)

Have a pilot order its escorts to dock.

Parameters

parent

Pilot giving the order.

Definition at line 330 of file escort.c.