SCR_BaseSupportStationComponentClass Interface Reference

Inheritance diagram for SCR_BaseSupportStationComponentClass:

Public Member Functions
bool	GetSendNotificationOnUse ()
	Get if notification should be shown on Action executed.
bool	CanMoveWithPhysics ()
	If false then the object has no physics to move it self.
bool	AllowGetFactionFromParent ()
	Check if prefab allows the faction affiliation component to be obtained from parent Used in init.
SCR_AudioSourceConfiguration	GetOnUseAudioConfig ()
	Get Audio config to play Will create it if it not yet exists.
SCR_AudioSourceConfiguration	CreateOnUseAudioConfig (ResourceName soundFile, string soundEvent)
	Get Audio config to play Will create it if it not yet exists.
void	GetCharacterVoiceSoundEventVariables (out string characterVoiceEventOnUse, out int characterVoicePriority)
	Get the character voice varriables on support station use.

Protected Attributes
bool	m_bIsVehicle
bool	m_bSendNotificationOnUse
bool	m_bAllowGetFactionFromParent
ResourceName	m_sOnUseSoundEffectFile
string	m_sOnUseSoundEffectEventName
string	m_sCharacterVoiceEventOnUse
int	m_iCharacterVoicePriority
ref SCR_AudioSourceConfiguration	m_OnUseAudioSourceConfiguration

Member Function Documentation

AllowGetFactionFromParent()

bool SCR_BaseSupportStationComponentClass.AllowGetFactionFromParent

(

)

Check if prefab allows the faction affiliation component to be obtained from parent Used in init.

Returns

If allowed to get from parent

CanMoveWithPhysics()

bool SCR_BaseSupportStationComponentClass.CanMoveWithPhysics

(

)

If false then the object has no physics to move it self.

If true it means it can be moved via physics which means it checks the rigid body if it has a velocity and does not allow to be used if it has

Returns

false if no physics can move it

CreateOnUseAudioConfig()

SCR_AudioSourceConfiguration SCR_BaseSupportStationComponentClass.CreateOnUseAudioConfig	(	ResourceName	soundFile,
		string	soundEvent )

Get Audio config to play Will create it if it not yet exists.

Returns null if no SoundFile or SoundEvent is set

Returns

Sound Config

GetCharacterVoiceSoundEventVariables()

void SCR_BaseSupportStationComponentClass.GetCharacterVoiceSoundEventVariables	(	out string	characterVoiceEventOnUse,
		out int	characterVoicePriority )

Get the character voice varriables on support station use.

Parameters

[out]	characterVoiceEventOnUse	Voice event to use
[out]	characterVoicePriority	priority of voice event

GetOnUseAudioConfig()

SCR_AudioSourceConfiguration SCR_BaseSupportStationComponentClass.GetOnUseAudioConfig

(

)

Get Audio config to play Will create it if it not yet exists.

Returns null if no SoundFile or SoundEvent is set

Returns

Sound Config

GetSendNotificationOnUse()

bool SCR_BaseSupportStationComponentClass.GetSendNotificationOnUse

(

)

Get if notification should be shown on Action executed.

Returns

True if should show notification

Member Data Documentation

m_bAllowGetFactionFromParent

bool SCR_BaseSupportStationComponentClass.m_bAllowGetFactionFromParent

protected

m_bIsVehicle

bool SCR_BaseSupportStationComponentClass.m_bIsVehicle

protected

m_bSendNotificationOnUse

bool SCR_BaseSupportStationComponentClass.m_bSendNotificationOnUse

protected

m_iCharacterVoicePriority

int SCR_BaseSupportStationComponentClass.m_iCharacterVoicePriority

protected

m_OnUseAudioSourceConfiguration

ref SCR_AudioSourceConfiguration SCR_BaseSupportStationComponentClass.m_OnUseAudioSourceConfiguration

protected

m_sCharacterVoiceEventOnUse

string SCR_BaseSupportStationComponentClass.m_sCharacterVoiceEventOnUse

protected

m_sOnUseSoundEffectEventName

string SCR_BaseSupportStationComponentClass.m_sOnUseSoundEffectEventName

protected

m_sOnUseSoundEffectFile

ResourceName SCR_BaseSupportStationComponentClass.m_sOnUseSoundEffectFile

protected

---

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

• Game/Components/SupportStation/SCR_BaseSupportStationComponent.c