SCR_BinocularsComponent Interface Reference

Inheritance diagram for SCR_BinocularsComponent:

Public Member Functions
override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
	Set gadget mode.
override void	ModeClear (EGadgetMode mode)
	Clear gadget mode.
override void	ToggleFocused (bool enable)
	Toggle gadget focus state.
override EGadgetType	GetType ()
	Get gadget type.
override bool	CanBeRaised ()
	Gadget has a raised animation version.
override bool	IsUsingADSControls ()
	Gadget uses ADS controls from gadget raisable context.
override bool	IsVisibleEquipped ()
	Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.
void	~SCR_BinocularsComponent ()
Public Member Functions inherited from SCR_GadgetComponent
EGadgetAnimVariable	GetAnimVariable ()
float	GetWeaponNoFireTime ()
bool	IsToggledOn ()
	Is gadget toggled on/off.
void	OnToggleActive (bool state)
	Event called from SCR_GadgetManagerComponent through RPC request.
void	OnParentSlotChanged (InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot)
	InventoryItemComponent event.
void	OnModeChanged (EGadgetMode mode, IEntity charOwner)
	Gadget mode change event.
void	OnSlotOccludedStateChanged (bool occluded)
	Method called when slot to which item is attached to changed its occlusion state.
void	ActivateGadgetUpdate ()
	Activate gadget frame update.
void	DeactivateGadgetUpdate ()
	Deactivate gadget frame flag.
void	UpdateVisibility (EGadgetMode mode)
	Set visibility when show/hide hand animation starts/finishes.
void	ToggleActive (bool state, SCR_EUseContext context)
	Synchronise gadget state.
void	ActivateAction ()
	Action listener callback.
void	ToggleFocused (bool enable)
	Toggle gadget focus state.
ChimeraCharacter	GetCharacterOwner ()
	Get IEntity in possession of this Gadget.
EGadgetType	GetType ()
	Get gadget type.
EGadgetMode	GetMode ()
	Get gadget mode.
bool	CanBeHeld ()
	Can be held in hand.
SCR_EUseContext	GetUseMask ()
	Provides value that contains mask of contexts from which this gadget can be toggled.
bool	CanBeRaised ()
	Gadget has a raised animation version.
bool	IsUsingADSControls ()
	Gadget uses ADS controls from gadget raisable context.
bool	IsVisibleEquipped ()
	Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.
void	Update (float timeSlice)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override void	OnDelete (IEntity owner)
override void	OnPostInit (IEntity owner)

Static Public Member Functions
static bool	IsZoomedView ()
	Get whether the local character is in a zoomed state.

Protected Attributes
Widget	m_RootWidget = null
SCR_2DOpticsComponent	m_Optic
Protected Attributes inherited from SCR_GadgetComponent
EGadgetAnimVariable	m_eAnimVariable
SCR_EUseContext	m_eUseMask
vector	m_vEquipmentSlotOffset
float	m_fWeaponNoFireTime
bool	m_bActivated = false
EGadgetMode	m_iMode = EGadgetMode.ON_GROUND
ChimeraCharacter	m_CharacterOwner

Static Protected Attributes
static ref ScriptInvoker	s_OnBinocToggled = new ScriptInvoker()
static bool	m_bZoomed = false

Additional Inherited Members
Public Attributes inherited from SCR_GadgetComponent
bool	m_bFocused
Protected Member Functions inherited from SCR_GadgetComponent
void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
	Set gadget mode.
void	ModeClear (EGadgetMode mode)
	Clear gadget mode.
void	ConnectToGadgetsSystem ()
	Starts on frame update event.
void	DisconnectFromGadgetsSystem ()
Protected Member Functions inherited from ScriptGameComponent
bool	OnTicksOnRemoteProxy ()

Constructor & Destructor Documentation

~SCR_BinocularsComponent()

void SCR_BinocularsComponent.~SCR_BinocularsComponent

(

)

Member Function Documentation

CanBeRaised()

override bool SCR_BinocularsComponent.CanBeRaised

(

)

Gadget has a raised animation version.

Returns

Returns true if raisable

Implements SCR_GadgetComponent.

GetType()

override EGadgetType SCR_BinocularsComponent.GetType

(

)

Get gadget type.

Returns

Returns gadget type

Implements SCR_GadgetComponent.

IsUsingADSControls()

override bool SCR_BinocularsComponent.IsUsingADSControls

(

)

Gadget uses ADS controls from gadget raisable context.

Returns

Returns true if using the controls

Implements SCR_GadgetComponent.

IsVisibleEquipped()

override bool SCR_BinocularsComponent.IsVisibleEquipped

(

)

Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.

Returns

Returns true if visible in equipment slot

Implements SCR_GadgetComponent.

IsZoomedView()

static bool SCR_BinocularsComponent.IsZoomedView ( )

static

Get whether the local character is in a zoomed state.

ModeClear()

override void SCR_BinocularsComponent.ModeClear

(

EGadgetMode

mode

)

Clear gadget mode.

Parameters

[in]

mode

is the mode being cleared

Implements SCR_GadgetComponent.

ModeSwitch()

override void SCR_BinocularsComponent.ModeSwitch	(	EGadgetMode	mode,
		IEntity	charOwner
	)

Set gadget mode.

Parameters

[in]	mode	is the target mode being switched to
[in]	charOwner

Implements SCR_GadgetComponent.

ToggleFocused()

override void SCR_BinocularsComponent.ToggleFocused

(

bool

enable

)

Toggle gadget focus state.

Parameters

[in]

enable

is target state

Implements SCR_GadgetComponent.

Member Data Documentation

m_bZoomed

bool SCR_BinocularsComponent.m_bZoomed = false

staticprotected

m_Optic

SCR_2DOpticsComponent SCR_BinocularsComponent.m_Optic

protected

m_RootWidget

Widget SCR_BinocularsComponent.m_RootWidget = null

protected

s_OnBinocToggled

ref ScriptInvoker SCR_BinocularsComponent.s_OnBinocToggled = new ScriptInvoker()

staticprotected

---

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

• Game/Components/Gadgets/SCR_BinocularsComponent.c