Data Structures
class	BaseChatEntityClass

class	BaseGameEntityClass

class	DestructibleEntity

class	DestructibleEntityClass

class	DestructionManagerClass

class	EntityUtils

class	GameEntityClass

class	HitRegistrationManagerClass

class	MusicManagerClass

class	PowerlineEntityClass
	Represents a single segment of power line grid between two power poles. More...

class	PowerPoleEntityClass

class	RadioManagerEntityClass

class	RegionalDestructionManagerClass

class	SoundWorldClass

class	TurretClass

class	VehiclePartPanelClass

class	VehiclePartRotorClass

Functions
BaseChatEntityClass GenericEntityClass	GetChannelsCount ()

proto external string	GetChannelName (int channelId)

proto external BaseChatChannel	GetChannel (int channelId)

proto external PrivateMessageChannel	GetWhisperChannel ()

proto external BaseChatChannel	GetDefaultChannel ()

proto external BaseChatChannelStyle	GetStyle ()

BaseGameEntityClass GenericEntityClass	Teleport (vector mat[4])

proto external RplComponent	GetRplComponent ()
	Returns the replication component associated to this entity. More...

proto external bool	GetAncestorToLocalTransform (IEntity ancestor, out vector result[4])

proto external bool	GetLocalToAncestorTransform (IEntity ancestor, out vector result[4])

HitRegistrationManagerClass GenericEntityClass	GetProxyBufferingLatency ()
	Returns the desired buffering delay of world and bone positions that are received from the server. More...

MusicManagerClass GenericEntityClass	Play (string musicName)
	'Forces' a sound to play without taking into account the automated evaluation process More...

proto external void	Stop (string musicName)
	Stops either a specific Music that is playing by name OR stops whatever is currently playing (when the string is empty) More...

proto external void	MuteCategory (MusicCategory musicCategory, bool mute, bool stopNow)
	(Un)Mutes a category locally. Does not influence any categories muted from server side More...

proto external void	RequestServerMuteCategory (MusicCategory musicCategory, bool mute)
	Requests server (from any client) to mute a category on the server, this muted category is seperated from your own (locally) muted categories. More...

proto external bool	ServerIsCategoryMuted (MusicCategory musicCategory)
	Checks whether a given category is muted by the server (game master) More...

proto external void	SetManagerSignals ()
	Sets default used MusicManager signals. More...

proto external int	GetSignalIndex (string name)
	Get index for signal name. Return -1 if signal not found. More...

proto external void	SetSignalValue (int index, float value)
	Set signal value by 'index'. Index is obtained by GetSignalIndex method. More...

proto external void	SetSignalValueStr (string signal, float value)
	Set signal value by signal name. More...

RadioManagerEntityClass GenericEntityClass	GetTransceiversInRange (vector position, float range, out notnull array< BaseTransceiver > tsvList)

SoundWorldClass GenericEntityClass	GetMapValuesAtPos (vector pos, out float sea, out float forest, out float city, out float meadow)

proto void	GetMapValuesAdvAtPos (vector pos, out float river, out float riverSlope, out float lake, out float coast)

proto void	CalculateInterirorAt (vector pos, InteriorRequestCallback callback)

Variables
VehiclePartPanelClass	m_fMaterialVariable = 0
	Read-only variable filled from code, used to animate material. More...

Detailed Description

Function Documentation

◆ CalculateInterirorAt()

proto void CalculateInterirorAt	(	vector	pos,
		InteriorRequestCallback	callback
	)

◆ GetAncestorToLocalTransform()

proto external bool GetAncestorToLocalTransform	(	IEntity	ancestor,
		out vector	result[4]
	)

Returns a matrix that transforms a point in ancestor-space to local-space.

Parameters

	ancestor	The Entity whose space is the source of the transformation. Can't be null.
[out]	outResult	The output matrix transformation.

Returns: true, if ancestor-descendant relationship was valid. Else false, in which case outResult is undefined.

◆ GetChannel()

proto external BaseChatChannel GetChannel ( int channelId )

Parameters

[channelId] Channel ID indexed from 0.

Returns: Channel or null if ID is invalid

◆ GetChannelName()

proto external string GetChannelName ( int channelId )

Parameters

[channelId] Defined by BaseChatEntity. Indexed from 0.

Returns: Name of channel as defined in BaseChatEntity

◆ GetChannelsCount()

BaseChatEntityClass GenericEntityClass GetChannelsCount ( )

Returns: Total number of channels

◆ GetDefaultChannel()

proto external BaseChatChannel GetDefaultChannel ( )

Returns: Returns the channel which was setup as default

◆ GetLocalToAncestorTransform()

proto external bool GetLocalToAncestorTransform	(	IEntity	ancestor,
		out vector	result[4]
	)

Returns a matrix that transforms a point in local-space to ancestor-space.

Parameters

	ancestor	The Entity whose space is the target of the transformation. Can't be null.
[out]	outResult	The output matrix transformation.

Returns: true, if ancestor-descendant relationship was valid. Else false, in which case outResult is undefined.

◆ GetMapValuesAdvAtPos()

proto void GetMapValuesAdvAtPos	(	vector	pos,
		out float	river,
		out float	riverSlope,
		out float	lake,
		out float	coast
	)

◆ GetMapValuesAtPos()

SoundWorldClass GenericEntityClass GetMapValuesAtPos	(	vector	pos,
		out float	sea,
		out float	forest,
		out float	city,
		out float	meadow
	)

◆ GetProxyBufferingLatency()

HitRegistrationManagerClass GenericEntityClass GetProxyBufferingLatency ( )

Returns the desired buffering delay of world and bone positions that are received from the server.

Returns: The buffering delay, in seconds.

◆ GetRplComponent()

proto external RplComponent GetRplComponent ( )

Returns the replication component associated to this entity.

Returns

Definition at line 200 of file SCR_RespawnComponent.c.

◆ GetSignalIndex()

proto external int GetSignalIndex ( string name )

Get index for signal name. Return -1 if signal not found.

◆ GetStyle()

proto external BaseChatChannelStyle GetStyle ( )

Returns: Base channel style object.

◆ GetTransceiversInRange()

RadioManagerEntityClass GenericEntityClass GetTransceiversInRange	(	vector	position,
		float	range,
		out notnull array< BaseTransceiver >	tsvList
	)

Gets all transceivers in given range that are in power ON state.

Parameters

[in]	range	Range in meters
[out]	tsvList	Fresh list of BaseTransceivers in range

Returns: Number of BaseTransceivers returned

◆ GetWhisperChannel()

proto external PrivateMessageChannel GetWhisperChannel ( )

Returns: Channel or null if no whisper channel is configured

◆ MuteCategory()

proto external void MuteCategory	(	MusicCategory	musicCategory,
		bool	mute,
		bool	stopNow
	)

(Un)Mutes a category locally. Does not influence any categories muted from server side

◆ Play()

MusicManagerClass GenericEntityClass Play ( string musicName )

'Forces' a sound to play without taking into account the automated evaluation process

◆ RequestServerMuteCategory()

proto external void RequestServerMuteCategory	(	MusicCategory	musicCategory,
		bool	mute
	)

Requests server (from any client) to mute a category on the server, this muted category is seperated from your own (locally) muted categories.

◆ ServerIsCategoryMuted()

proto external bool ServerIsCategoryMuted ( MusicCategory musicCategory )

Checks whether a given category is muted by the server (game master)

◆ SetManagerSignals()

proto external void SetManagerSignals ( )

Sets default used MusicManager signals.

◆ SetSignalValue()

proto external void SetSignalValue	(	int	index,
		float	value
	)

Set signal value by 'index'. Index is obtained by GetSignalIndex method.

◆ SetSignalValueStr()

proto external void SetSignalValueStr	(	string	signal,
		float	value
	)

Set signal value by signal name.

◆ Stop()

proto external void Stop ( string musicName )

Stops either a specific Music that is playing by name OR stops whatever is currently playing (when the string is empty)

◆ Teleport()

BaseGameEntityClass GenericEntityClass Teleport ( vector mat[4] )

Teleport the entity to a coordinate

Parameters

mat	The matrix used for the teleportation

Variable Documentation

◆ m_fMaterialVariable

VehiclePartPanelClass m_fMaterialVariable = 0

Read-only variable filled from code, used to animate material.

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ CalculateInterirorAt()

◆ GetAncestorToLocalTransform()

◆ GetChannel()

◆ GetChannelName()

◆ GetChannelsCount()

◆ GetDefaultChannel()

◆ GetLocalToAncestorTransform()

◆ GetMapValuesAdvAtPos()

◆ GetMapValuesAtPos()

◆ GetProxyBufferingLatency()

◆ GetRplComponent()

◆ GetSignalIndex()

◆ GetStyle()

◆ GetTransceiversInRange()

◆ GetWhisperChannel()

◆ MuteCategory()

◆ Play()

◆ RequestServerMuteCategory()

◆ ServerIsCategoryMuted()

◆ SetManagerSignals()

◆ SetSignalValue()

◆ SetSignalValueStr()

◆ Stop()

◆ Teleport()

Variable Documentation

◆ m_fMaterialVariable