MissionScriptApi Class Reference

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

Public Member Functions
uint[]	GetMissionAirplaneFormation (uint missionEntityId)
	Get airplane formation assigned to a mission More...
int	GetEnemyCount (uint missionEntityId)
	Get the number of enemy planes reported More...
bool	IsMissionSuccessful (uint missionEntityId)
	Get mission result More...
int	GetNumberOfEventsSent (uint missionEntityId)
	Get the amount of events sent during a mission More...

Detailed Description

This class is available under a global missions_api variable.

Member Function Documentation

GetEnemyCount()

int GetEnemyCount ( uint  missionEntityId )

inline

Get the number of enemy planes reported

Parameters

missionEntityId

Entity id of mission

Returns

The number of enemy planes reported

GetMissionAirplaneFormation()

uint [] GetMissionAirplaneFormation ( uint  missionEntityId )

inline

Get airplane formation assigned to a mission

Parameters

missionEntityId

Entity id of mission

Returns

Return array of ids of airplanes assigned to mission

GetNumberOfEventsSent()

int GetNumberOfEventsSent ( uint  missionEntityId )

inline

Get the amount of events sent during a mission

Parameters

missionEntityId

Entity id of mission

Returns

Returns the amount of mission events already sent

IsMissionSuccessful()

bool IsMissionSuccessful ( uint  missionEntityId )

inline

Get mission result

Parameters

missionEntityId

Entity id of mission

Returns

Return whether a mission is successful or not