SCR_CampaignBuildingGadgetToolComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_CampaignBuildingGadgetToolComponentClass

Functions
SCR_CampaignBuildingGadgetToolComponentClass SCR_GadgetComponentClass	Attribute (defvalue:"25", desc:"Max distance at which the ghost preview is shown.")
override void	Update (float timeSlice)
override void	OnToggleActive (bool state)
override EGadgetType	GetType ()
override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
void	ToolToHand ()
	Building tool taken to hand - show preview etc. More...
void	OnPossessed (int playerID, bool isPossessing, RplId mainEntityID)
void	ToolToInventory ()
	Building tool out of hands - show preview. More...
SCR_EditorModeEntity	GetBuildingModeEntity ()
protected void	RemovePreviews ()
protected void	OnEditorOpened ()
	Method called when character has a shovel in hands and any editor mode is opned. More...
protected void	OnEditorClosed ()
	Method called when character has a shovel in hands and any editor mode is closed. More...
void	OnConsciousnessChanged (bool conscious)
	Will be called when the consciousness of the character changes. More...
void	RemoveOnConsciousnessChanged ()
protected bool	TraceCompositionToShowPreview ()
protected bool	EvaluatePreviewEntity (IEntity ent)
int	GetToolConstructionValue ()
SCR_CharacterControllerComponent	GetCharacterControllerComponent ()
void	RemoveEventHandlers ()

Variables
protected ref array< SCR_CampaignBuildingLayoutComponent >	m_aShownPreviewOld = {}
protected bool	m_bToolActiveWhenEditorOpen

Function Documentation

Attribute()

SCR_CampaignBuildingGadgetToolComponentClass SCR_GadgetComponentClass Attribute	(	defvalue:"25"	,
		desc:"Max distance at which the ghost preview is shown."
	)

Definition at line 7 of file SCR_CampaignBuildingGadgetToolComponent.c.

EvaluatePreviewEntity()

protected bool EvaluatePreviewEntity

(

IEntity

ent

)

Definition at line 328 of file SCR_CampaignBuildingGadgetToolComponent.c.

GetBuildingModeEntity()

SCR_EditorModeEntity GetBuildingModeEntity

(

)

Search for an editor mode entity (exists only when the player is in editor mode)

Returns

Definition at line 167 of file SCR_CampaignBuildingGadgetToolComponent.c.

GetCharacterControllerComponent()

SCR_CharacterControllerComponent GetCharacterControllerComponent

(

)

Returns

Definition at line 351 of file SCR_CampaignBuildingGadgetToolComponent.c.

GetToolConstructionValue()

int GetToolConstructionValue

(

)

Returns

the value how much this tool adds to a building value with one action

Definition at line 344 of file SCR_CampaignBuildingGadgetToolComponent.c.

GetType()

override EGadgetType GetType

(

)

Definition at line 52 of file SCR_CampaignBuildingGadgetToolComponent.c.

ModeSwitch()

override void ModeSwitch	(	EGadgetMode	mode,
		IEntity	charOwner
	)

Triggered when an operation with gadget is performed - picked up, taken into hands, back to backpack etc.

Parameters

[in]	mode
[in]	charOwner	must have a GadgetManager component

Definition at line 68 of file SCR_CampaignBuildingGadgetToolComponent.c.

OnEditorClosed()

protected void OnEditorClosed

(

)

Method called when character has a shovel in hands and any editor mode is closed.

Definition at line 218 of file SCR_CampaignBuildingGadgetToolComponent.c.

OnEditorOpened()

protected void OnEditorOpened

(

)

Method called when character has a shovel in hands and any editor mode is opned.

Definition at line 194 of file SCR_CampaignBuildingGadgetToolComponent.c.

OnPossessed()

void OnPossessed	(	int	playerID,
		bool	isPossessing,
		RplId	mainEntityID
	)

Parameters

[in]	playerID
[in]	isPossessing
[in]	mainEntityID

Definition at line 115 of file SCR_CampaignBuildingGadgetToolComponent.c.

OnToggleActive()

override void OnToggleActive

(

bool

state

)

Definition at line 41 of file SCR_CampaignBuildingGadgetToolComponent.c.

RemoveEventHandlers()

void RemoveEventHandlers

(

)

Definition at line 388 of file SCR_CampaignBuildingGadgetToolComponent.c.

RemoveOnConsciousnessChanged()

void RemoveOnConsciousnessChanged

(

)

Definition at line 251 of file SCR_CampaignBuildingGadgetToolComponent.c.

RemovePreviews()

protected void RemovePreviews

(

)

Definition at line 181 of file SCR_CampaignBuildingGadgetToolComponent.c.

ToolToHand()

void ToolToHand

(

)

Building tool taken to hand - show preview etc.

Definition at line 86 of file SCR_CampaignBuildingGadgetToolComponent.c.

ToolToInventory()

void ToolToInventory

(

)

Building tool out of hands - show preview.

Definition at line 150 of file SCR_CampaignBuildingGadgetToolComponent.c.

TraceCompositionToShowPreview()

protected bool TraceCompositionToShowPreview

(

)

Trace the possible previews

Returns

Definition at line 294 of file SCR_CampaignBuildingGadgetToolComponent.c.

Update()

override void Update

(

float

timeSlice

)

Parameters

[in]

timeSlice

Definition at line 28 of file SCR_CampaignBuildingGadgetToolComponent.c.

Variable Documentation

m_aShownPreviewOld

protected ref array<SCR_CampaignBuildingLayoutComponent> m_aShownPreviewOld = {}

Definition at line 21 of file SCR_CampaignBuildingGadgetToolComponent.c.

m_bToolActiveWhenEditorOpen

protected bool m_bToolActiveWhenEditorOpen

Definition at line 23 of file SCR_CampaignBuildingGadgetToolComponent.c.