SCR_MortarShellGadgetComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_MortarShellGadgetComponentClass

Functions
SCR_MortarShellGadgetComponentClass SCR_GadgetComponentClass	RplProp (onRplName:"OnChargeRingReplicated")
bool	IsUsingTimeFuze ()
float	GetMinFuzeTime ()
float	GetMaxFuzeTime ()
void	OverrideTimeFuzeConfig (bool shouldBeUsed=false, float min=0, float max=0)
float	GetDetonationAltitude ()
float	GetVerticalImpactTimeOffset ()
int	GetNumberOfChargeRingConfigurations ()
vector	GetChargeRingConfig (int id)
int	FindDefaultChargeRingConfig (out vector foundConfig=-vector.One)
override EGadgetType	GetType ()
override bool	CanBeRaised ()
override bool	IsVisibleEquipped ()
ScriptInvokerVoid	GetOnShellUsed ()
bool	IsLoaded ()
float	GetFuzeTime ()
vector	GetCurentChargeRingConfig ()
int	GetCurentChargeRingConfigId ()
void	OnChargeRingReplicated ()
	Callback method that will be triggered when m_iChargeRingConfigIndex is bumped for replication.
void	SetChargeRingConfig (int configId, bool silent=false, bool replicate=true)
void	OnShellFired (notnull BaseMuzzleComponent muzzle)
void	VisualiseChargeRings (int numberOfChargeRings)
bool	SetLoadedState (bool state, SCR_MortarMuzzleComponent mortarMuzzle=null, string fireActionName="", IEntity user=null)
void	UseShellCB ()
	Callback used to tell if user wants to fire the shell now.
override void	OnToggleActive (bool state)
override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
void	ModeClear (EGadgetMode mode)
void	SetFuzeTime (float time)
SCR_ShellConfig	GetSavedConfig (notnull ChimeraCharacter character)
	Retrieves locally saved data about manual adjustment of the fuze that player set for this shell type.
float	GetTimeToDetonation (float angle, bool isDirectFire)
	Retrieves information about the time of flight for this shell prefab.
override void	EOnInit (IEntity owner)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)

Variables
bool	m_bIsUsingTimeFuze
params	__pad0__
params	__pad1__
params	__pad2__
params	__pad3__
ref array< vector >	m_aChargeRingConfig

Function Documentation

CanBeRaised()

override bool CanBeRaised

(

)

Definition at line 199 of file SCR_MortarShellGadgetComponent.c.

FindDefaultChargeRingConfig()

int RplProp::FindDefaultChargeRingConfig ( out vector foundConfig = -vector.One )

protected

Searches for the first charge ring config that is marked as default

Parameters

[out]

foundConfig

or negative vector.One if no default one was found

Returns

id of the default config or -1 when such is not found

Definition at line 224 of file SCR_MortarShellGadgetComponent.c.

GetChargeRingConfig()

vector GetChargeRingConfig ( int id )

protected

Returns

Definition at line 212 of file SCR_MortarShellGadgetComponent.c.

GetCurentChargeRingConfig()

vector GetCurentChargeRingConfig

(

)

Returns

Definition at line 291 of file SCR_MortarShellGadgetComponent.c.

GetCurentChargeRingConfigId()

int GetCurentChargeRingConfigId

(

)

Returns

Definition at line 302 of file SCR_MortarShellGadgetComponent.c.

GetDetonationAltitude()

float GetDetonationAltitude ( )

protected

Returns

Definition at line 194 of file SCR_MortarShellGadgetComponent.c.

GetFuzeTime()

float GetFuzeTime

(

)

Returns

Definition at line 240 of file SCR_MortarShellGadgetComponent.c.

GetMaxFuzeTime()

float GetMaxFuzeTime ( )

protected

Returns

Definition at line 162 of file SCR_MortarShellGadgetComponent.c.

GetMinFuzeTime()

float GetMinFuzeTime ( )

protected

Returns

Definition at line 156 of file SCR_MortarShellGadgetComponent.c.

GetNumberOfChargeRingConfigurations()

int GetNumberOfChargeRingConfigurations ( )

protected

Returns

Definition at line 206 of file SCR_MortarShellGadgetComponent.c.

GetOnShellUsed()

ScriptInvokerVoid GetOnShellUsed

(

)

Returns

Definition at line 212 of file SCR_MortarShellGadgetComponent.c.

GetSavedConfig()

SCR_ShellConfig GetSavedConfig ( notnull ChimeraCharacter character )

protected

Retrieves locally saved data about manual adjustment of the fuze that player set for this shell type.

Definition at line 532 of file SCR_MortarShellGadgetComponent.c.

GetTimeToDetonation()

float GetTimeToDetonation ( float angle, bool isDirectFire )

protected

Retrieves information about the time of flight for this shell prefab.

Definition at line 547 of file SCR_MortarShellGadgetComponent.c.

GetType()

override EGadgetType GetType

(

)

Definition at line 193 of file SCR_MortarShellGadgetComponent.c.

GetVerticalImpactTimeOffset()

float RplProp::GetVerticalImpactTimeOffset ( )

protected

Definition at line 200 of file SCR_MortarShellGadgetComponent.c.

IsLoaded()

bool IsLoaded

(

)

Returns

Definition at line 222 of file SCR_MortarShellGadgetComponent.c.

IsUsingTimeFuze()

bool IsUsingTimeFuze ( )

protected

Returns

Definition at line 150 of file SCR_MortarShellGadgetComponent.c.

IsVisibleEquipped()

override bool IsVisibleEquipped

(

)

Definition at line 205 of file SCR_MortarShellGadgetComponent.c.

ModeClear()

void ModeClear ( EGadgetMode mode )

protected

Clear gadget mode

Parameters

[in]

mode

that is being cleared

Definition at line 498 of file SCR_MortarShellGadgetComponent.c.

ModeSwitch()

override void ModeSwitch ( EGadgetMode mode, IEntity charOwner )

protected

Definition at line 466 of file SCR_MortarShellGadgetComponent.c.

OnChargeRingReplicated()

void OnChargeRingReplicated ( )

protected

Callback method that will be triggered when m_iChargeRingConfigIndex is bumped for replication.

Definition at line 320 of file SCR_MortarShellGadgetComponent.c.

OnShellFired()

void OnShellFired ( notnull BaseMuzzleComponent muzzle )

protected

Method that is meant to be called when it is firred from a mortar

Parameters

[in]

muzzle

dfrom which this shell was fired

Definition at line 380 of file SCR_MortarShellGadgetComponent.c.

OnToggleActive()

override void OnToggleActive ( bool state )

protected

Definition at line 453 of file SCR_MortarShellGadgetComponent.c.

OverrideTimeFuzeConfig()

void RplProp::OverrideTimeFuzeConfig ( bool shouldBeUsed = false, float min = 0, float max = 0 )

protected

Overrides configuration of time fuze usage for all entities of this prefab

Parameters

[in]	shouldBeUsed	is set to true if time fuze should be used
[in]	min	fuze time value
[in]	max	fuze time value

Definition at line 172 of file SCR_MortarShellGadgetComponent.c.

RplLoad()

override bool RplLoad ( ScriptBitReader reader )

protected

Definition at line 649 of file SCR_MortarShellGadgetComponent.c.

RplProp()

SCR_MortarShellGadgetComponentClass SCR_GadgetComponentClass RplProp

(

onRplName:"OnChargeRingReplicated"

)

Definition at line 1 of file SCR_MortarShellGadgetComponent.c.

RplSave()

override bool RplSave ( ScriptBitWriter writer )

protected

Definition at line 630 of file SCR_MortarShellGadgetComponent.c.

SetChargeRingConfig()

void SetChargeRingConfig ( int configId, bool silent = false, bool replicate = true )

protected

Sets the number of charge rings that are going to be used to fire this projectile

Parameters

[in]	configId	id of the config that is going ot be used by the projectile
[in]	silent	determines if audio should be played
[in]	replicate	determines if it should attempt to replicate change to the currently selected charge ring config - this can only be done by the owner

Definition at line 330 of file SCR_MortarShellGadgetComponent.c.

SetFuzeTime()

void SetFuzeTime ( float time )

protected

Parameters

[in]

time

Definition at line 512 of file SCR_MortarShellGadgetComponent.c.

SetLoadedState()

bool SetLoadedState ( bool state, SCR_MortarMuzzleComponent mortarMuzzle = null, string fireActionName = "", IEntity user = null )

protected

Parameters

[in]	state	if shell should be locked and
[in]	mortarMuzzle	muzzle from which mortar this shell is going to be fired
[in]	fireActionName	name of the input action for which game should wait with transfering the item to mortar inventory
[in]	user	one who loads the shell

Returns

true if caller should wait for user to activate the gadget

Definition at line 422 of file SCR_MortarShellGadgetComponent.c.

UseShellCB()

void UseShellCB ( )

protected

Callback used to tell if user wants to fire the shell now.

Definition at line 445 of file SCR_MortarShellGadgetComponent.c.

VisualiseChargeRings()

void VisualiseChargeRings ( int numberOfChargeRings )

protected

Shows or hides charge ring visualiastion that are defined in prefab slot manager

Parameters

[in]

numberOfChargeRings

determines how many charge rings should be visible

Definition at line 393 of file SCR_MortarShellGadgetComponent.c.

Variable Documentation

__pad0__

params __pad0__

protected

Definition at line 134 of file SCR_MortarShellGadgetComponent.c.

__pad1__

params __pad1__

protected

Definition at line 137 of file SCR_MortarShellGadgetComponent.c.

__pad2__

params __pad2__

protected

Definition at line 140 of file SCR_MortarShellGadgetComponent.c.

__pad3__

params __pad3__

protectedattribute

Definition at line 143 of file SCR_MortarShellGadgetComponent.c.

m_aChargeRingConfig

ref array<vector> m_aChargeRingConfig

protected

Definition at line 147 of file SCR_MortarShellGadgetComponent.c.

m_bIsUsingTimeFuze

bool m_bIsUsingTimeFuze

protected

Definition at line 132 of file SCR_MortarShellGadgetComponent.c.