SCR_DamageSufferingSystem Interface Reference

Inheritance diagram for SCR_DamageSufferingSystem:

Public Member Functions
override bool	ShouldBePaused ()
	Is this system should be paused while the simulation is paused?
SCR_BatchedDamageEffects	GetBatchedDataOfType (notnull SCR_ExtendedDamageManagerComponent dmgMgr, TypeName t)
	Method used to find batched data about specified damage effect.
SCR_BatchedDamageEffects	GetBatchedDataForLocalCharacter (TypeName t)
	Method used to lookup batched data for locally controlled character.
void	RegisterEffect (notnull SCR_ExtendedDamageManagerComponent dmgMgr, notnull SCR_PersistentDamageEffect dmgEffect)
	Tries to add damage effect to the list of managed effects for the provided damage manager.
void	UnregisterEffect (notnull SCR_ExtendedDamageManagerComponent dmgMgr, notnull SCR_PersistentDamageEffect dmgEffect)
void	StartObservingControlledEntityChanges (notnull SCR_PlayerController controller, bool changing, bool becameOwner)
	Callback method for PlayerController ownership transfer.
Public Member Functions inherited from GameSystem
bool	ShouldBeEnabledInEditMode ()
	Is this system should be enabled inside the editor.

Static Public Member Functions
static override void	InitInfo (WorldSystemInfo outInfo)
static SCR_DamageSufferingSystem	GetInstance ()
static SCR_PersistentDamageEffect	GetVirtualInstanceOfDamageEffect (TypeName t)
	Returns a cached virtual instance of the damage effect of the provided type.

Protected Member Functions
override void	OnUpdatePoint (WorldUpdatePointArgs args)
void	OnControlledEntityChanged (IEntity from, IEntity to)
	Callback method used to inform that locally controlled entity has changed.

Protected Attributes
ref map< SCR_ExtendedDamageManagerComponent, ref SCR_ManagedDamageEffectsContainer >	m_mManagedDamageEffects
SCR_ExtendedDamageManagerComponent	m_LocallyControlledCharactersDmgMgr
SCR_ManagedDamageEffectsContainer	m_LocallyControlledCharacterData

Member Function Documentation

GetBatchedDataForLocalCharacter()

SCR_BatchedDamageEffects SCR_DamageSufferingSystem.GetBatchedDataForLocalCharacter

(

TypeName

t

)

Method used to lookup batched data for locally controlled character.

Parameters

[in]

t

type of the damage effect

Returns

found batched set of data, or null

GetBatchedDataOfType()

SCR_BatchedDamageEffects SCR_DamageSufferingSystem.GetBatchedDataOfType	(	notnull SCR_ExtendedDamageManagerComponent	dmgMgr,
		TypeName	t )

Method used to find batched data about specified damage effect.

Parameters

[in]	dmgMgr
[in]	t	type of the damage effect

Returns

found batched set of data, or null

GetInstance()

static SCR_DamageSufferingSystem SCR_DamageSufferingSystem.GetInstance ( )

static

Returns

GetVirtualInstanceOfDamageEffect()

static SCR_PersistentDamageEffect SCR_DamageSufferingSystem.GetVirtualInstanceOfDamageEffect ( TypeName t )

static

Returns a cached virtual instance of the damage effect of the provided type.

Parameters

[in]

t

type of a class which inherits from SCR_PersistentDamageEffect

Returns

cached instance of the provided type

InitInfo()

static override void SCR_DamageSufferingSystem.InitInfo ( WorldSystemInfo outInfo )

static

OnControlledEntityChanged()

void SCR_DamageSufferingSystem.OnControlledEntityChanged ( IEntity from, IEntity to )

protected

Callback method used to inform that locally controlled entity has changed.

Parameters

[in]	from	previously controlled entity
[in]	to	currently controlled entity

OnUpdatePoint()

override void SCR_DamageSufferingSystem.OnUpdatePoint ( WorldUpdatePointArgs args )

protected

RegisterEffect()

void SCR_DamageSufferingSystem.RegisterEffect	(	notnull SCR_ExtendedDamageManagerComponent	dmgMgr,
		notnull SCR_PersistentDamageEffect	dmgEffect )

Tries to add damage effect to the list of managed effects for the provided damage manager.

Parameters

[in]	dmgMgr
[in]	dmgEffect

ShouldBePaused()

override bool SCR_DamageSufferingSystem.ShouldBePaused

(

)

Is this system should be paused while the simulation is paused?

Implements GameSystem.

StartObservingControlledEntityChanges()

void SCR_DamageSufferingSystem.StartObservingControlledEntityChanges	(	notnull SCR_PlayerController	controller,
		bool	changing,
		bool	becameOwner )

Callback method for PlayerController ownership transfer.

For more information see PlayerController.OnOwnershipChanged

Parameters

[in]	controller
[in]	changing	true if ownership is being transferred
[in]	becameOwner	true if local client is now the owner of this controller

UnregisterEffect()

void SCR_DamageSufferingSystem.UnregisterEffect	(	notnull SCR_ExtendedDamageManagerComponent	dmgMgr,
		notnull SCR_PersistentDamageEffect	dmgEffect )

Parameters

[in]	dmgMgr
[in]	dmgEffect

Member Data Documentation

m_LocallyControlledCharacterData

SCR_ManagedDamageEffectsContainer SCR_DamageSufferingSystem.m_LocallyControlledCharacterData

protected

m_LocallyControlledCharactersDmgMgr

SCR_ExtendedDamageManagerComponent SCR_DamageSufferingSystem.m_LocallyControlledCharactersDmgMgr

protected

m_mManagedDamageEffects

ref map<SCR_ExtendedDamageManagerComponent, ref SCR_ManagedDamageEffectsContainer> SCR_DamageSufferingSystem.m_mManagedDamageEffects

protected

---

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

• Game/Systems/SCR_DamageSufferingSystem.c