SCR_MeleeComponent Class Reference

Inheritance diagram for SCR_MeleeComponent:

Protected Member Functions
bool	HasBayonet ()
OnMeleePerformedInvoker	GetOnMeleePerformed ()
void	PerformAttack ()
	Called from character command handler, based on user input.
void	SetMeleeAttackStarted (bool started)
bool	TraceFilter (notnull IEntity ent)
vector	GetAimingVector (notnull ChimeraCharacter character)
bool	CheckCollisionsSimple (out SCR_MeleeHitDataClass pHitData)
void	CollectMeleeWeaponProperties ()
void	HandleMeleeSound ()
	Handles playing of sound & setting of signals (AUDIO).
void	PlaySound (IEntity weaponEntity, vector position, int signalValue0, int signalValue1)
void	RPC_HandleMeleeSound (RplId weaponID, vector position, int signalValue0, int signalValue1)
SCR_DamageManagerComponent	SearchHierarchyForDamageManager (IEntity startEntity, out HitZone hitZone)
void	ProcessMeleeAttack ()
	Processes the melee attack. Applies the damage if applicable.
void	HandleDamageDelayed ()
void	Do_OnFrameCleanup ()
	cleanup
void	Debug_DrawSphereAtPos (vector v, array< ref Shape > dbgShapes, int color=COLOR_BLUE, float size=0.03, ShapeFlags shapeFlags=ShapeFlags.VISIBLE)
	DEBUG methods.
void	Debug_DrawSphereAtPos (vector pos, int color, array< ref Shape > dbgShapes)
void	Debug_DrawLineSimple (vector start, vector end, array< ref Shape > dbgShapes)
void	Update (float timeSlice)
	Event methods.
override void	OnPostInit (IEntity owner)
override void	EOnInit (IEntity owner)

Protected Attributes
ref SCR_MeleeHitDataClass	m_MeleeHitData
bool	m_bMeasurementDone
	holds melee hit data
bool	m_bAttackAlreadyExecuted = false
bool	m_bMeleeAttackStarted = false
	attack execution limiter
float	m_fWeaponMeleeAccuracy
float	m_fWeaponMeleeRange
ref OnMeleePerformedInvoker	m_OnMeleePerformed
SCR_MeleeWeaponProperties	m_MeleeWeaponProperties
bool	m_bHasBayonet

Detailed Description

Definition at line 24 of file SCR_MeleeComponent.c.

Member Function Documentation

CheckCollisionsSimple()

bool SCR_MeleeComponent::CheckCollisionsSimple ( out SCR_MeleeHitDataClass pHitData )

inlineprotected

Primary collision check that uses TraceMove and single TraceSphere fired from character eye pos along the aim fwd vector

Parameters

[in]

pHitData

SCR_MeleeHitDataClass holder that keeps information about actual hit

Returns

When hit is detected or it is miss

Definition at line 112 of file SCR_MeleeComponent.c.

CollectMeleeWeaponProperties()

void SCR_MeleeComponent::CollectMeleeWeaponProperties ( )

inlineprotected

Prepare information from MeleeWeaponProperties component on weapon

Parameters

[in]

weapon

Equipped melee weapon we are getting the data from

get current weapon and store it into SCR_MeleeHitDataClass instance

Definition at line 160 of file SCR_MeleeComponent.c.

Debug_DrawLineSimple()

void SCR_MeleeComponent::Debug_DrawLineSimple ( vector start, vector end, array< ref Shape > dbgShapes )

inlineprotected

Definition at line 445 of file SCR_MeleeComponent.c.

Debug_DrawSphereAtPos() [1/2]

void SCR_MeleeComponent::Debug_DrawSphereAtPos ( vector pos, int color, array< ref Shape > dbgShapes )

inlineprotected

Definition at line 433 of file SCR_MeleeComponent.c.

Debug_DrawSphereAtPos() [2/2]

void SCR_MeleeComponent::Debug_DrawSphereAtPos ( vector v, array< ref Shape > dbgShapes, int color = COLOR_BLUE, float size = 0.03, ShapeFlags shapeFlags = ShapeFlags.VISIBLE )

inlineprotected

DEBUG methods.

Drawing of sphere if specified attributes on given vector pos

Definition at line 420 of file SCR_MeleeComponent.c.

Do_OnFrameCleanup()

void SCR_MeleeComponent::Do_OnFrameCleanup ( )

inlineprotected

cleanup

Cleanup of several variables called on frame

Definition at line 397 of file SCR_MeleeComponent.c.

EOnInit()

override void SCR_MeleeComponent::EOnInit ( IEntity owner )

inlineprotected

Definition at line 490 of file SCR_MeleeComponent.c.

GetAimingVector()

vector SCR_MeleeComponent::GetAimingVector ( notnull ChimeraCharacter character )

inlineprotected

Definition at line 99 of file SCR_MeleeComponent.c.

GetOnMeleePerformed()

OnMeleePerformedInvoker SCR_MeleeComponent::GetOnMeleePerformed ( )

inlineprotected

Returns

Definition at line 54 of file SCR_MeleeComponent.c.

HandleDamageDelayed()

void SCR_MeleeComponent::HandleDamageDelayed ( )

inlineprotected

Definition at line 336 of file SCR_MeleeComponent.c.

HandleMeleeSound()

void SCR_MeleeComponent::HandleMeleeSound ( )

inlineprotected

Handles playing of sound & setting of signals (AUDIO).

Definition at line 205 of file SCR_MeleeComponent.c.

HasBayonet()

bool SCR_MeleeComponent::HasBayonet ( )

inlineprotected

Returns

Definition at line 47 of file SCR_MeleeComponent.c.

OnPostInit()

override void SCR_MeleeComponent::OnPostInit ( IEntity owner )

inlineprotected

Definition at line 483 of file SCR_MeleeComponent.c.

PerformAttack()

void SCR_MeleeComponent::PerformAttack ( )

inlineprotected

Called from character command handler, based on user input.

Definition at line 64 of file SCR_MeleeComponent.c.

PlaySound()

void SCR_MeleeComponent::PlaySound ( IEntity weaponEntity, vector position, int signalValue0, int signalValue1 )

inlineprotected

Definition at line 236 of file SCR_MeleeComponent.c.

ProcessMeleeAttack()

void SCR_MeleeComponent::ProcessMeleeAttack ( )

inlineprotected

Processes the melee attack. Applies the damage if applicable.

Definition at line 311 of file SCR_MeleeComponent.c.

RPC_HandleMeleeSound()

void SCR_MeleeComponent::RPC_HandleMeleeSound ( RplId weaponID, vector position, int signalValue0, int signalValue1 )

inlineprotected

Definition at line 266 of file SCR_MeleeComponent.c.

SearchHierarchyForDamageManager()

SCR_DamageManagerComponent SCR_MeleeComponent::SearchHierarchyForDamageManager ( IEntity startEntity, out HitZone hitZone )

inlineprotected

Goes upwards the hierarchy of startEntity searching for SCR_DamageManagerComponent to deal damage to

Parameters

[in]	startEntity
[out]	hitZone

Returns

the found SCR_DamageManagerComponent or null if not found or if startEntity is null

Definition at line 284 of file SCR_MeleeComponent.c.

SetMeleeAttackStarted()

void SCR_MeleeComponent::SetMeleeAttackStarted ( bool started )

inlineprotected

Enable or disable measuring of hit detection probes

Parameters

[in]

state

if is/is not allowed to measure

Definition at line 81 of file SCR_MeleeComponent.c.

TraceFilter()

bool SCR_MeleeComponent::TraceFilter ( notnull IEntity ent )

inlineprotected

Definition at line 90 of file SCR_MeleeComponent.c.

Update()

void SCR_MeleeComponent::Update ( float timeSlice )

inlineprotected

Event methods.

Parameters

[in]

timeSlice

Definition at line 473 of file SCR_MeleeComponent.c.

Member Data Documentation

m_bAttackAlreadyExecuted

bool SCR_MeleeComponent::m_bAttackAlreadyExecuted = false

protected

Definition at line 35 of file SCR_MeleeComponent.c.

m_bHasBayonet

bool SCR_MeleeComponent::m_bHasBayonet

protected

Definition at line 43 of file SCR_MeleeComponent.c.

m_bMeasurementDone

bool SCR_MeleeComponent::m_bMeasurementDone

protected

holds melee hit data

Definition at line 34 of file SCR_MeleeComponent.c.

m_bMeleeAttackStarted

bool SCR_MeleeComponent::m_bMeleeAttackStarted = false

protected

attack execution limiter

Definition at line 36 of file SCR_MeleeComponent.c.

m_fWeaponMeleeAccuracy

float SCR_MeleeComponent::m_fWeaponMeleeAccuracy

protected

Definition at line 37 of file SCR_MeleeComponent.c.

m_fWeaponMeleeRange

float SCR_MeleeComponent::m_fWeaponMeleeRange

protected

Definition at line 38 of file SCR_MeleeComponent.c.

m_MeleeHitData

ref SCR_MeleeHitDataClass SCR_MeleeComponent::m_MeleeHitData

protected

Definition at line 33 of file SCR_MeleeComponent.c.

m_MeleeWeaponProperties

SCR_MeleeWeaponProperties SCR_MeleeComponent::m_MeleeWeaponProperties

protected

Definition at line 40 of file SCR_MeleeComponent.c.

m_OnMeleePerformed

ref OnMeleePerformedInvoker SCR_MeleeComponent::m_OnMeleePerformed

protected

Definition at line 39 of file SCR_MeleeComponent.c.

---

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

• scripts/Game/Character/Melee/SCR_MeleeComponent.c