Classes
class	SCR_MortarMuzzleComponentClass

Functions
SCR_MortarMuzzleComponentClass MortarMuzzleComponentClass	Attribute (desc:"Position and rotation that will be used to play animation of dropping the shell")
string	GetFireActionName ()
string	GetFirePowerSignalName ()
vector	GetVerticalAngleLimits ()
override void	EOnInit (IEntity owner)
bool	IsBeingLoaded ()
void	SetLoadingState (bool newState)
vector	GetMuzzleDirection ()
float	GetMuzzleElevation ()
void	OnShellLoaded (IEntity item, int slotID)
void	LoadShell (notnull SCR_MortarShellGadgetComponent shellComp, notnull ChimeraCharacter character, float fuzeTime=-1, bool fromLeftSide=false)
void	SetAnimationAttributes (notnull CharacterControllerComponent controller, bool loadedFromLeftSide)
void	OnWeaponFired (IEntity effectEntity, BaseMuzzleComponent muzzle, IEntity projectileEntity)
	Called when launcher fires; Trace in the opposite direction of the warhead and apply damage to surrounding area.
ChimeraCharacter	FindResponsibleCharacter (notnull SCR_CharacterControllerComponent controller)
void	ResetRecoilAnimationVariable (TAnimGraphVariable varId)
	Method used to reset the animation variable to its default value.
void	OnAnimationEvent (AnimationEventID animEventType, AnimationEventID animUserString, int intParam, float timeFromStart, float timeToEnd, SCR_CharacterControllerComponent controller)
void	TransferShellToMortar ()
void	OnAnimationEnded (IEntity item, bool successful, ItemUseParameters animParams)
void	SynchronizeLoaderData (RplId loaderRplId, RplId shellRplId, float fuseTime, bool loadedFromLeftSide)

Variables
string	m_sFireActionName
string	m_sFirePowerSignalName
vector	m_vVerticalAngleLimits

Function Documentation

◆ Attribute()

SCR_MortarMuzzleComponentClass MortarMuzzleComponentClass Attribute ( desc:"Position and rotation that will be used to play animation of dropping the shell" )

Definition at line 1 of file SCR_MortarMuzzleComponent.c.

◆ FindResponsibleCharacter()

ChimeraCharacter FindResponsibleCharacter ( notnull SCR_CharacterControllerComponent controller )

protected

Method used determine who should be blamed for the damage that shell will do

Parameters

[in] controller of the loader

Returns: character that should be considered a responsible party for the damage that shell will do

Definition at line 306 of file SCR_MortarMuzzleComponent.c.

◆ GetFireActionName()

string Attribute::GetFireActionName ( )

protected

Definition at line 45 of file SCR_MortarMuzzleComponent.c.

◆ GetFirePowerSignalName()

string Attribute::GetFirePowerSignalName ( )

protected

Definition at line 51 of file SCR_MortarMuzzleComponent.c.

◆ GetMuzzleDirection()

vector GetMuzzleDirection ( )

Definition at line 97 of file SCR_MortarMuzzleComponent.c.

◆ GetMuzzleElevation()

float GetMuzzleElevation ( )

Definition at line 109 of file SCR_MortarMuzzleComponent.c.

◆ GetVerticalAngleLimits()

vector Attribute::GetVerticalAngleLimits ( )

protected

Definition at line 57 of file SCR_MortarMuzzleComponent.c.

◆ IsBeingLoaded()

bool IsBeingLoaded ( )

Definition at line 85 of file SCR_MortarMuzzleComponent.c.

◆ LoadShell()

void LoadShell	(	notnull SCR_MortarShellGadgetComponent	shellComp,
		notnull ChimeraCharacter	character,
		float	fuzeTime = -1,
		bool	fromLeftSide = false )

Starts the animation of dropping the shell in the mortar barrel.

Parameters

[in]	shellComp	from loaded shell
[in]	character	loader who will be responsible for the damage that shell will cause
[in]	fuzeTime	when set to -1 then new one will be calculated based on curent muzzle elevation
[in]	fromLeftSide	if loading animation should use left point info

Definition at line 140 of file SCR_MortarMuzzleComponent.c.

◆ OnAnimationEnded()

void OnAnimationEnded	(	IEntity	item,
		bool	successful,
		ItemUseParameters	animParams )

protected

Callback called when animation of using the item ends

Parameters

[in]	item	animated item
[in]	successful	if animation was able to finish or was interrupted
[in]	animParams	parameters that were used to play this animation

Definition at line 468 of file SCR_MortarMuzzleComponent.c.

◆ OnAnimationEvent()

void OnAnimationEvent	(	AnimationEventID	animEventType,
		AnimationEventID	animUserString,
		int	intParam,
		float	timeFromStart,
		float	timeToEnd,
		SCR_CharacterControllerComponent	controller )

protected

Callback called when animation event happens.

Parameters

[in]	animEventType	ID of animation event.
[in]	animUserString	String parameter of animation event
[in]	intParam	int parameter of animation event
[in]	timeFromStart	time from Start of animation event
[in]	timeToEnd	time to end of animation event
[in]	controller	which triggered this event

Reset camera override so it does not follow animation

Override camera to follow animation while firing

Definition at line 354 of file SCR_MortarMuzzleComponent.c.

◆ OnShellLoaded()

void OnShellLoaded	(	IEntity	item,
		int	slotID )

Call back method that is triggered on item insertion and is used to play shell loading sound

Parameters

[in]	item	that was inserted
[in]	slotID

Definition at line 118 of file SCR_MortarMuzzleComponent.c.

◆ OnWeaponFired()

void OnWeaponFired	(	IEntity	effectEntity,
		BaseMuzzleComponent	muzzle,
		IEntity	projectileEntity )

protected

Called when launcher fires; Trace in the opposite direction of the warhead and apply damage to surrounding area.

Callback method used to trigger mortar recoil animation

Parameters

[in]	effectEntity
[in]	muzzle
[in]	projectileEntity

Definition at line 270 of file SCR_MortarMuzzleComponent.c.

◆ ResetRecoilAnimationVariable()

void ResetRecoilAnimationVariable ( TAnimGraphVariable varId )

protected

Method used to reset the animation variable to its default value.

Definition at line 337 of file SCR_MortarMuzzleComponent.c.

◆ SetAnimationAttributes()

void SetAnimationAttributes	(	notnull CharacterControllerComponent	controller,
		bool	loadedFromLeftSide )

protected

Method used to set currently used animation attributes

Parameters

[in]	controller	of the character that is going to be executing the animation
[in]	loadedFromLeftSide

Definition at line 246 of file SCR_MortarMuzzleComponent.c.

◆ SetLoadingState()

void SetLoadingState ( bool newState )

Definition at line 91 of file SCR_MortarMuzzleComponent.c.

◆ SynchronizeLoaderData()

void SynchronizeLoaderData	(	RplId	loaderRplId,
		RplId	shellRplId,
		float	fuseTime,
		bool	loadedFromLeftSide )

protected

Definition at line 499 of file SCR_MortarMuzzleComponent.c.

◆ TransferShellToMortar()

void TransferShellToMortar ( )

protected

Moves currently loaded shell from loaders inventory to the mortar inventory It will also attempt to find next shell that should be equipped when current shell is successfully transferred

Definition at line 426 of file SCR_MortarMuzzleComponent.c.

Variable Documentation

◆ m_sFireActionName

string m_sFireActionName

protected

Definition at line 36 of file SCR_MortarMuzzleComponent.c.

◆ m_sFirePowerSignalName

string m_sFirePowerSignalName

protected

Definition at line 39 of file SCR_MortarMuzzleComponent.c.

◆ m_vVerticalAngleLimits

vector m_vVerticalAngleLimits

protected

Definition at line 42 of file SCR_MortarMuzzleComponent.c.

Classes

Functions

Variables

Function Documentation

◆ Attribute()

◆ FindResponsibleCharacter()

◆ GetFireActionName()

◆ GetFirePowerSignalName()

◆ GetMuzzleDirection()

◆ GetMuzzleElevation()

◆ GetVerticalAngleLimits()

◆ IsBeingLoaded()

◆ LoadShell()

◆ OnAnimationEnded()

◆ OnAnimationEvent()

◆ OnShellLoaded()

◆ OnWeaponFired()

◆ ResetRecoilAnimationVariable()

◆ SetAnimationAttributes()

◆ SetLoadingState()

◆ SynchronizeLoaderData()

◆ TransferShellToMortar()

Variable Documentation

◆ m_sFireActionName

◆ m_sFirePowerSignalName

◆ m_vVerticalAngleLimits