SCR_BaseDamageHealSupportStationComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_BaseDamageHealSupportStationComponentClass

Enumerations
enum	SCR_EDamageSupportStationHealState {   FIRE_EXTINGUISH_UPDATE, FIRE_EXTINGUISH_DONE, DOT_REMOVED, HEAL_UPDATE,   HEAL_DONE_NOT_FULL_HEAL, HEAL_DONE, BLOOD_UPDATE, BLOOD_DONE_NOT_FULL_HEAL,   BLOOD_DONE }

Functions
SCR_BaseDamageHealSupportStationComponentClass SCR_BaseSupportStationComponentClass	Attribute ("500", desc:"Max damage healed each execute. If you hold the action it will heal each time the action ends", category:"Heal/Repair Support Station", params:"0.01 inf")
SCR_AudioSourceConfiguration	CreateSoundAudioConfig (string soundEventName)
SCR_AudioSourceConfiguration	GetOnHealUpdateAudioConfig ()
SCR_AudioSourceConfiguration	GetOnDoTRemovedAudioConfig ()
override bool	IsValid (IEntity actionOwner, IEntity actionUser, SCR_BaseUseSupportStationAction action, vector actionPosition, out ESupportStationReasonInvalid reasonInvalid, out int supplyCost)
protected float	GetDamageOrStateToHeal (IEntity actionOwner, IEntity actionUser, notnull SCR_BaseDamageHealSupportStationAction action, out EDamageType activeDoT, out notnull array< HitZone > hitZones)
protected override int	GetSupplyCostAction (IEntity actionOwner, IEntity actionUser, SCR_BaseUseSupportStationAction action)
override void	OnExecutedServer (notnull IEntity actionOwner, notnull IEntity actionUser, notnull SCR_BaseUseSupportStationAction action)
protected override void	OnExecute (IEntity actionOwner, IEntity actionUser, int playerId, SCR_BaseUseSupportStationAction action)
protected void	OnExecuteDamageSystemBroadcast (RplId ownerId, RplId userId, SCR_EDamageSupportStationHealState healState, int actionId, float healthScaled)
protected void	OnExecuteDamageSystem (IEntity actionOwner, IEntity actionUser, SCR_EDamageSupportStationHealState healState, SCR_BaseDamageHealSupportStationAction action, float healthScaled)
protected void	SendDamageSupportStationNotification (IEntity actionOwner, IEntity actionUser, SCR_BaseUseSupportStationAction action, SCR_EDamageSupportStationHealState healState, float healthScaled)

Variables
protected string	m_sOnHealUpdateSoundEffectEventName
protected string	m_sOnDoTRemovedSoundEffectEventName
protected ref SCR_AudioSourceConfiguration	m_OnHealUpdateAudioSourceConfiguration
protected ref SCR_AudioSourceConfiguration	m_OnDoTRemovedAudioSourceConfiguration

Enumeration Type Documentation

SCR_EDamageSupportStationHealState

enum SCR_EDamageSupportStationHealState

Enumerator
FIRE_EXTINGUISH_UPDATE	To notify the system that the fire extinguish was updated but the fire state is not removed.
FIRE_EXTINGUISH_DONE	To notify the system that the fire extinguish was updated but the fire state was removed.
DOT_REMOVED	To notify the system that a Damage over time effect was removed.
HEAL_UPDATE	To notify the system that health was updated but healing is not done.
HEAL_DONE_NOT_FULL_HEAL	To notify the system that health was updated and healing is done. But the entity is not full heal aka the repair station cannot heal more.
HEAL_DONE	To notify the system that health was updated and healing is done.
BLOOD_UPDATE	To notify the system that blood amount was updated but healing is not done.
BLOOD_DONE_NOT_FULL_HEAL	To notify the system that blood amount was updated and healing is done, but the entity is not full blood aka the heal station cannot heal more blood.
BLOOD_DONE	To notify the system that blood amount was updated and healing is done.

Definition at line 366 of file SCR_BaseDamageHealSupportStationComponent.c.

Function Documentation

Attribute()

SCR_BaseDamageHealSupportStationComponentClass SCR_BaseSupportStationComponentClass Attribute	(	"500"	,
		desc:"Max damage healed each execute. If you hold the action it will heal each time the action ends"	,
		category:"Heal/Repair Support Station"	,
		params:"0.01 inf"
	)

Definition at line 62 of file SCR_BaseDamageHealSupportStationComponent.c.

CreateSoundAudioConfig()

SCR_AudioSourceConfiguration Attribute::CreateSoundAudioConfig

(

string

soundEventName

)

Get Audio config to play Will create it if it not yet exists. Returns null if no SoundFile or SoundEvent is set

Parameters

[in]

soundEventName

DSConfig

Returns

Definition at line 16 of file SCR_BaseDamageHealSupportStationComponent.c.

GetDamageOrStateToHeal()

protected float GetDamageOrStateToHeal	(	IEntity	actionOwner,
		IEntity	actionUser,
		notnull SCR_BaseDamageHealSupportStationAction	action,
		out EDamageType	activeDoT,
		out notnull array< HitZone >	hitZones
	)

Definition at line 134 of file SCR_BaseDamageHealSupportStationComponent.c.

GetOnDoTRemovedAudioConfig()

SCR_AudioSourceConfiguration Attribute::GetOnDoTRemovedAudioConfig

(

)

Returns

Sound Config for heal update. Will return null if no audio is assigned

Definition at line 48 of file SCR_BaseDamageHealSupportStationComponent.c.

GetOnHealUpdateAudioConfig()

SCR_AudioSourceConfiguration Attribute::GetOnHealUpdateAudioConfig

(

)

Returns

Sound Config for heal update. Will return null if no audio is assigned

Definition at line 37 of file SCR_BaseDamageHealSupportStationComponent.c.

GetSupplyCostAction()

protected override int GetSupplyCostAction	(	IEntity	actionOwner,
		IEntity	actionUser,
		SCR_BaseUseSupportStationAction	action
	)

Definition at line 158 of file SCR_BaseDamageHealSupportStationComponent.c.

IsValid()

override bool IsValid	(	IEntity	actionOwner,
		IEntity	actionUser,
		SCR_BaseUseSupportStationAction	action,
		vector	actionPosition,
		out ESupportStationReasonInvalid	reasonInvalid,
		out int	supplyCost
	)

Definition at line 98 of file SCR_BaseDamageHealSupportStationComponent.c.

OnExecute()

protected override void OnExecute	(	IEntity	actionOwner,
		IEntity	actionUser,
		int	playerId,
		SCR_BaseUseSupportStationAction	action
	)

Definition at line 281 of file SCR_BaseDamageHealSupportStationComponent.c.

OnExecuteDamageSystem()

protected void OnExecuteDamageSystem	(	IEntity	actionOwner,
		IEntity	actionUser,
		SCR_EDamageSupportStationHealState	healState,
		SCR_BaseDamageHealSupportStationAction	action,
		float	healthScaled
	)

Definition at line 306 of file SCR_BaseDamageHealSupportStationComponent.c.

OnExecuteDamageSystemBroadcast()

protected void OnExecuteDamageSystemBroadcast	(	RplId	ownerId,
		RplId	userId,
		SCR_EDamageSupportStationHealState	healState,
		int	actionId,
		float	healthScaled
	)

Definition at line 288 of file SCR_BaseDamageHealSupportStationComponent.c.

OnExecutedServer()

override void OnExecutedServer	(	notnull IEntity	actionOwner,
		notnull IEntity	actionUser,
		notnull SCR_BaseUseSupportStationAction	action
	)

Definition at line 205 of file SCR_BaseDamageHealSupportStationComponent.c.

SendDamageSupportStationNotification()

protected void SendDamageSupportStationNotification	(	IEntity	actionOwner,
		IEntity	actionUser,
		SCR_BaseUseSupportStationAction	action,
		SCR_EDamageSupportStationHealState	healState,
		float	healthScaled
	)

Definition at line 360 of file SCR_BaseDamageHealSupportStationComponent.c.

Variable Documentation

m_OnDoTRemovedAudioSourceConfiguration

protected ref SCR_AudioSourceConfiguration m_OnDoTRemovedAudioSourceConfiguration

Definition at line 9 of file SCR_BaseDamageHealSupportStationComponent.c.

m_OnHealUpdateAudioSourceConfiguration

protected ref SCR_AudioSourceConfiguration m_OnHealUpdateAudioSourceConfiguration

Definition at line 8 of file SCR_BaseDamageHealSupportStationComponent.c.

m_sOnDoTRemovedSoundEffectEventName

protected string m_sOnDoTRemovedSoundEffectEventName

Definition at line 6 of file SCR_BaseDamageHealSupportStationComponent.c.

m_sOnHealUpdateSoundEffectEventName

protected string m_sOnHealUpdateSoundEffectEventName

Definition at line 3 of file SCR_BaseDamageHealSupportStationComponent.c.