CharacterScriptApi Class Reference

This class is available under a global characters variable. More...

Public Member Functions
uint	GetVoxelObjectId (string characterId)
	Retrieve a voxel object visualDataID from a character.
bool	DestroyCarriedResource (string characterId)
	Destroy the resource carried by a character.
int	GetPilotMissionCount (string characterId)
	Get the amount of flight missions a pilot has completed.
int	GetPilotSuccessfulMissionCount (string characterId)
	Get the amount of successful flight missions a pilot has completed.
void	SetTemporaryMoraleState (string characterId, CharacterMoraleStateFlag moraleStateFlag, int duration)
	Set a morale state for a temporary amount of time on a single character on the base.

Detailed Description

This class is available under a global characters variable.

Member Function Documentation

DestroyCarriedResource()

bool DestroyCarriedResource ( string characterId )

inline

Destroy the resource carried by a character.

Parameters

characterId

visualDataID of the character

Returns

true if successful, false otherwise (wrong visualDataID, character isn't carrying anything)

GetPilotMissionCount()

int GetPilotMissionCount ( string characterId )

inline

Get the amount of flight missions a pilot has completed.

Parameters

characterId

visualDataID of the character

Returns

Number of flight missions that a pilot has completed

GetPilotSuccessfulMissionCount()

int GetPilotSuccessfulMissionCount ( string characterId )

inline

Get the amount of successful flight missions a pilot has completed.

Parameters

characterId

visualDataID of the character

Returns

Number of flight missions a pilot has completed that resulted in a success

GetVoxelObjectId()

uint GetVoxelObjectId ( string characterId )

inline

Retrieve a voxel object visualDataID from a character.

Parameters

characterId

visualDataID of the character

Returns

Voxel object visualDataID

SetTemporaryMoraleState()

void SetTemporaryMoraleState ( string characterId, CharacterMoraleStateFlag moraleStateFlag, int duration )

inline

Set a morale state for a temporary amount of time on a single character on the base.

Parameters

characterId	Id of character
moraleStateFlag	Morale state flag
duration	Duration of morale state