ChimeraGame Interface Reference

Inheritance diagram for ChimeraGame:

Public Member Functions
proto external bool	IsExperimentalBuild ()
	Is the game experimental build.
proto external ScriptWorldClock	GetClock ()
	Returns the world clock.
proto external GameSignalsManager	GetSignalsManager ()
	returns the global signals manager
proto external PlayerController	GetPlayerController ()
	returns entity holding info about player
proto external PlayerManager	GetPlayerManager ()
	PlayerManager holding info about players who joined MP. It always returns a valid instance.
proto external GameBlocklist	GetGameBlocklist ()
proto external PerceptionManager	GetPerceptionManager ()
proto external FactionManager	GetFactionManager ()
	returns entity holding info about factions
proto external BaseChatEntity	GetChat ()
	Returns the chat entity.
proto external CameraManager	GetCameraManager ()
	Returns the camera manager.
proto external BaseGameMode	GetGameMode ()
	Returns the game mode.
proto external MapEntity	GetMapManager ()
	Returns the map manager entity.
proto external SaveGameManager	GetSaveGameManager ()
	SaveGameManager holds all meta info about available save-games.
proto external void	SetViewDistance (float viewDistance)
	Sets view distance in meters (far clipping plane of cameras)
proto external float	GetViewDistance ()
	Returns view distance in meters (far clipping plane of cameras)
proto external float	GetMaximumViewDistance ()
	Returns absolute maximum view distance per platform as defined by global chimera settings.
proto external float	GetMinimumViewDistance ()
	Returns absolute minimum view distance per platform as defined by global chimera settings.
proto external void	SetGrassDistance (int grassDistance)
	Sets grass distance in meters.
proto external int	GetGrassDistance ()
	Returns grass distance in meters.
proto external int	GetMaximumGrassDistance ()
	Returns absolute maximum grass distance.
proto external int	GetMinimumGrassDistance ()
	Returns absolute minimum grass distance.
proto external float	GetViewDistanceServerLimit ()
	Returns the maximum view distance set by server (never relevant to client) set via ServerConfig.
proto external bool	IsVONUIDisabledByServer ()
	Returns true if the VON UI is disabled by the server.
proto external bool	IsVONDirectSpeechUIDisabledByServer ()
	Returns true if the VON direct speech UI is disabled by the server.
proto external bool	GetVONCanTransmitCrossFaction ()
	Returns true if the VONCanTransmitCrossFaction is enabled by the server.
proto external MissionHeader	GetMissionHeader ()
	Returns currently active mission or null if none.
proto external ResourceName	GetSystemsConfig ()
	Returns currently used systems config.
proto external AIWorld	GetAIWorld ()
	Returns the AI World.
proto external GameStatsApi	GetStatsApi ()
	Returns analytics Api.
proto external ServerInfo	GetServerInfo ()
	Returns game ServerInfo or null if not available.
proto external bool	IsCrossPlayEnabled ()
	Tells if the cross-play is enabled based on curent platform and user settings.
proto external bool	SetCrossPlay (bool enabled)
	Sets the cross-play option with respect to the platform specific requirements.
proto external void	LogFPS (int msec)
	Enable or disable the logging of FPS.
proto external float	GetGameInstallStatus ()
	Efective on game consoles, where parts of game may be installled in the background.
proto external IEntity	SpawnEntityPrefabLocal (notnull Resource templateResource, BaseWorld world=null, EntitySpawnParams params=null)
	Spawns a prefab which will exist only on local machine.
void	OnCrossPlayChanged ()
void	OnUserSignedOut ()
	Called whenever user is signed out while being in main menu game state.
void	OnCinematicStart ()
void	OnCinematicEnd ()
void	OnCinematicBlending (float blendFactor, vector cameraPosition)
void	OnGameInstallComplete ()
	Called when game is fully installed. Used on game consoles, where parts of game may be installled in the background.

Static Public Member Functions
static proto bool	CanSpawnEntityPrefab (notnull Resource templateResource, EntitySpawnParams params=null)
	Checks is a prefab can be spawned localy.

Protected Member Functions
void	OnBeforeWorldCleanup ()
	Called when the current world is about to be unloaded.
void	OnMissionSet (MissionHeader mission)
	Called when a mission header is set (to both a valid one or to null as well)
void	OnKickedFromGame (KickCauseCode kickCode)
	Called after player was kicked from game back to main menu, providing reason for the kick.
void	ShowErrorMessage (string msg)
	Shows dialog with a provided string.
ref Managed	GetPlayerDataStats (int playerID)
	Called when the player data is requested.
ref Managed	GetSessionDataStats ()
	Called when the session data is requested.
string	GetMissionName ()
	Called when DS downloads required addons and is ready to run a world FIXME: I'm not named properly!

Member Function Documentation

CanSpawnEntityPrefab()

static proto bool ChimeraGame.CanSpawnEntityPrefab ( notnull Resource templateResource, EntitySpawnParams params = null )

static

Checks is a prefab can be spawned localy.

Required for multiplayer

GetAIWorld()

proto external AIWorld ChimeraGame.GetAIWorld

(

)

Returns the AI World.

GetCameraManager()

proto external CameraManager ChimeraGame.GetCameraManager

(

)

Returns the camera manager.

GetChat()

proto external BaseChatEntity ChimeraGame.GetChat

(

)

Returns the chat entity.

GetClock()

proto external ScriptWorldClock ChimeraGame.GetClock

(

)

Returns the world clock.

GetFactionManager()

proto external FactionManager ChimeraGame.GetFactionManager

(

)

returns entity holding info about factions

GetGameBlocklist()

proto external GameBlocklist ChimeraGame.GetGameBlocklist

(

)

GetGameInstallStatus()

proto external float ChimeraGame.GetGameInstallStatus

(

)

Efective on game consoles, where parts of game may be installled in the background.

GetGameMode()

proto external BaseGameMode ChimeraGame.GetGameMode

(

)

Returns the game mode.

GetGrassDistance()

proto external int ChimeraGame.GetGrassDistance

(

)

Returns grass distance in meters.

GetMapManager()

proto external MapEntity ChimeraGame.GetMapManager

(

)

Returns the map manager entity.

GetMaximumGrassDistance()

proto external int ChimeraGame.GetMaximumGrassDistance

(

)

Returns absolute maximum grass distance.

GetMaximumViewDistance()

proto external float ChimeraGame.GetMaximumViewDistance

(

)

Returns absolute maximum view distance per platform as defined by global chimera settings.

GetMinimumGrassDistance()

proto external int ChimeraGame.GetMinimumGrassDistance

(

)

Returns absolute minimum grass distance.

GetMinimumViewDistance()

proto external float ChimeraGame.GetMinimumViewDistance

(

)

Returns absolute minimum view distance per platform as defined by global chimera settings.

GetMissionHeader()

proto external MissionHeader ChimeraGame.GetMissionHeader

(

)

Returns currently active mission or null if none.

GetMissionName()

string ChimeraGame.GetMissionName ( )

protected

Called when DS downloads required addons and is ready to run a world FIXME: I'm not named properly!

Implemented in ArmaReforgerScripted.

GetPerceptionManager()

proto external PerceptionManager ChimeraGame.GetPerceptionManager

(

)

GetPlayerController()

proto external PlayerController ChimeraGame.GetPlayerController

(

)

returns entity holding info about player

GetPlayerDataStats()

ref Managed ChimeraGame.GetPlayerDataStats ( int playerID )

protected

Called when the player data is requested.

Implemented in ArmaReforgerScripted.

GetPlayerManager()

proto external PlayerManager ChimeraGame.GetPlayerManager

(

)

PlayerManager holding info about players who joined MP. It always returns a valid instance.

GetSaveGameManager()

proto external SaveGameManager ChimeraGame.GetSaveGameManager

(

)

SaveGameManager holds all meta info about available save-games.

GetServerInfo()

proto external ServerInfo ChimeraGame.GetServerInfo

(

)

Returns game ServerInfo or null if not available.

GetSessionDataStats()

ref Managed ChimeraGame.GetSessionDataStats ( )

protected

Called when the session data is requested.

Implemented in ArmaReforgerScripted.

GetSignalsManager()

proto external GameSignalsManager ChimeraGame.GetSignalsManager

(

)

returns the global signals manager

GetStatsApi()

proto external GameStatsApi ChimeraGame.GetStatsApi

(

)

Returns analytics Api.

Examples

D:/jenkins/cpu/workspace/ar_data_branches_stable_1.7.0/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

GetSystemsConfig()

proto external ResourceName ChimeraGame.GetSystemsConfig

(

)

Returns currently used systems config.

GetViewDistance()

proto external float ChimeraGame.GetViewDistance

(

)

Returns view distance in meters (far clipping plane of cameras)

GetViewDistanceServerLimit()

proto external float ChimeraGame.GetViewDistanceServerLimit

(

)

Returns the maximum view distance set by server (never relevant to client) set via ServerConfig.

GetVONCanTransmitCrossFaction()

proto external bool ChimeraGame.GetVONCanTransmitCrossFaction

(

)

Returns true if the VONCanTransmitCrossFaction is enabled by the server.

IsCrossPlayEnabled()

proto external bool ChimeraGame.IsCrossPlayEnabled

(

)

Tells if the cross-play is enabled based on curent platform and user settings.

IsExperimentalBuild()

proto external bool ChimeraGame.IsExperimentalBuild

(

)

Is the game experimental build.

IsVONDirectSpeechUIDisabledByServer()

proto external bool ChimeraGame.IsVONDirectSpeechUIDisabledByServer

(

)

Returns true if the VON direct speech UI is disabled by the server.

IsVONUIDisabledByServer()

proto external bool ChimeraGame.IsVONUIDisabledByServer

(

)

Returns true if the VON UI is disabled by the server.

LogFPS()

proto external void ChimeraGame.LogFPS

(

int

msec

)

Enable or disable the logging of FPS.

Parameters

msec	gap in milliseconds at which time the log/calculate FPS is calculated. <= 0 to disable it.

OnBeforeWorldCleanup()

void ChimeraGame.OnBeforeWorldCleanup ( )

protected

Called when the current world is about to be unloaded.

Can be used to disable any event listeners that would otherwise react to entities being deleted during gameplay.

Implemented in ArmaReforgerScripted.

OnCinematicBlending()

void ChimeraGame.OnCinematicBlending	(	float	blendFactor,
		vector	cameraPosition )

Implemented in ArmaReforgerScripted.

OnCinematicEnd()

void ChimeraGame.OnCinematicEnd

(

)

Implemented in ArmaReforgerScripted.

OnCinematicStart()

void ChimeraGame.OnCinematicStart

(

)

Implemented in ArmaReforgerScripted.

OnCrossPlayChanged()

void ChimeraGame.OnCrossPlayChanged

(

)

OnGameInstallComplete()

void ChimeraGame.OnGameInstallComplete

(

)

Called when game is fully installed. Used on game consoles, where parts of game may be installled in the background.

Implemented in ArmaReforgerScripted.

OnKickedFromGame()

void ChimeraGame.OnKickedFromGame ( KickCauseCode kickCode )

protected

Called after player was kicked from game back to main menu, providing reason for the kick.

Implemented in ArmaReforgerScripted.

OnMissionSet()

void ChimeraGame.OnMissionSet ( MissionHeader mission )

protected

Called when a mission header is set (to both a valid one or to null as well)

Parameters

mission

can be passed in as null when mission is cleared, make sure to nullptr check!

Implemented in ArmaReforgerScripted.

OnUserSignedOut()

void ChimeraGame.OnUserSignedOut

(

)

Called whenever user is signed out while being in main menu game state.

Implemented in ArmaReforgerScripted.

SetCrossPlay()

proto external bool ChimeraGame.SetCrossPlay

(

bool

enabled

)

Sets the cross-play option with respect to the platform specific requirements.

E.g., if the Xbox user does not possess cross-play privilege and this method is called with enabled = true, the function returns false while the Xbox system UI will be shown in order to try obtain the cross-play privilege.

Returns

True if the option was successfully set to desired value.

SetGrassDistance()

proto external void ChimeraGame.SetGrassDistance

(

int

grassDistance

)

Sets grass distance in meters.

SetViewDistance()

proto external void ChimeraGame.SetViewDistance

(

float

viewDistance

)

Sets view distance in meters (far clipping plane of cameras)

ShowErrorMessage()

void ChimeraGame.ShowErrorMessage ( string msg )

protected

Shows dialog with a provided string.

Implemented in ArmaReforgerScripted.

SpawnEntityPrefabLocal()

proto external IEntity ChimeraGame.SpawnEntityPrefabLocal	(	notnull Resource	templateResource,
		BaseWorld	world = null,
		EntitySpawnParams	params = null )

Spawns a prefab which will exist only on local machine.

---

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

• Game/generated/ChimeraGame.c