SCR_EditorPreviewParams Class Reference

Network packet of variables for entity placing and transformation. More...

Protected Member Functions
void	GetWorldTransform (out vector outTransform[4])
bool	Deserialize ()
void	SetTarget (SCR_EditableEntityComponent target)
SCR_BaseEditorAction	GetSourceAction (notnull IEntity actionCompOwner)

Static Protected Member Functions
static void	Encode (SSnapSerializerBase snapshot, ScriptCtx hint, ScriptBitSerializer packet)
static bool	Decode (ScriptBitSerializer packet, ScriptCtx hint, SSnapSerializerBase snapshot)
static bool	SnapCompare (SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx hint)
static bool	PropCompare (SCR_EditorPreviewParams prop, SSnapSerializerBase snapshot, ScriptCtx hint)
static bool	Extract (SCR_EditorPreviewParams prop, ScriptCtx hint, SSnapSerializerBase snapshot)
static bool	Inject (SSnapSerializerBase snapshot, ScriptCtx hint, SCR_EditorPreviewParams prop)
static int	PackActionInfo (notnull SCR_BaseEditorAction action, notnull IEntity actionCompOwner)
static SCR_EditorPreviewParams	CreateParams (vector transform[4], RplId parentID=Replication.INVALID_ID, EEditorTransformVertical verticalMode=EEditorTransformVertical.SEA, bool isUnderwater=false, SCR_EditableEntityComponent target=null, EEditableEntityInteraction targetInteraction=EEditableEntityInteraction.NONE)
static SCR_EditorPreviewParams	CreateParamsFromPreview (SCR_PreviewEntityEditorComponent previewManager, SCR_EditableEntityComponent parent=null, bool parentChanged=false)

Protected Attributes
SCR_BaseEditorAction	m_SourceAction
	local cache of the action which was the reason for creation of this param

Detailed Description

Network packet of variables for entity placing and transformation.

Definition at line 4 of file SCR_EditorPreviewParams.c.

Member Function Documentation

CreateParams()

SCR_EditorPreviewParams SCR_EditorPreviewParams::CreateParams ( vector transform[4], RplId parentID = Replication.INVALID_ID, EEditorTransformVertical verticalMode = EEditorTransformVertical.SEA, bool isUnderwater = false, SCR_EditableEntityComponent target = null, EEditableEntityInteraction targetInteraction = EEditableEntityInteraction.NONE )

inlinestaticprotected

Create params for entity placement.

Parameters

transform	Transformation matrix where the entity will be created
parentID	Replication ID of parent entity
verticalMode	Alignment rules
isUnderwater	True if the entity is being placed under water surface
targetID	Replication ID of entity on/inside which the new entity is being spawned
targetInteraction	Type of interaction with the target entity

Returns

Params packet

Definition at line 220 of file SCR_EditorPreviewParams.c.

CreateParamsFromPreview()

SCR_EditorPreviewParams SCR_EditorPreviewParams::CreateParamsFromPreview ( SCR_PreviewEntityEditorComponent previewManager, SCR_EditableEntityComponent parent = null, bool parentChanged = false )

inlinestaticprotected

Create params packet for network transmission.

Parameters

previewManager	Manager from which individual params will be extracted - must not be null
parent	Currently selected parent layer
parentChanged	True if current layer changed while editing

Returns

Params packet or null if an error was encountered

Definition at line 246 of file SCR_EditorPreviewParams.c.

Decode()

bool SCR_EditorPreviewParams::Decode ( ScriptBitSerializer packet, ScriptCtx hint, SSnapSerializerBase snapshot )

inlinestaticprotected

Definition at line 34 of file SCR_EditorPreviewParams.c.

Deserialize()

bool SCR_EditorPreviewParams::Deserialize ( )

inlineprotected

Convert replication-friendly values to actual variables.

Returns

True if the deserialization was completed successfully

Definition at line 118 of file SCR_EditorPreviewParams.c.

Encode()

void SCR_EditorPreviewParams::Encode ( SSnapSerializerBase snapshot, ScriptCtx hint, ScriptBitSerializer packet )

inlinestaticprotected

Definition at line 28 of file SCR_EditorPreviewParams.c.

Extract()

bool SCR_EditorPreviewParams::Extract ( SCR_EditorPreviewParams prop, ScriptCtx hint, SSnapSerializerBase snapshot )

inlinestaticprotected

Definition at line 61 of file SCR_EditorPreviewParams.c.

GetSourceAction()

SCR_BaseEditorAction SCR_EditorPreviewParams::GetSourceAction ( notnull IEntity actionCompOwner )

inlineprotected

Finds and returns the action which was used for creation of this SCR_EditorPreviewParams instance

Parameters

actionCompOwner

IEntity which has editor actions components

Returns

action instance from stored action info

Definition at line 194 of file SCR_EditorPreviewParams.c.

GetWorldTransform()

void SCR_EditorPreviewParams::GetWorldTransform ( out vector outTransform[4] )

inlineprotected

Get world transformation matrix. If offset is used, it will be applied to it.

Parameters

[out]

outTransform

Variable to be filled with transformation matrix

Definition at line 97 of file SCR_EditorPreviewParams.c.

Inject()

bool SCR_EditorPreviewParams::Inject ( SSnapSerializerBase snapshot, ScriptCtx hint, SCR_EditorPreviewParams prop )

inlinestaticprotected

Definition at line 78 of file SCR_EditorPreviewParams.c.

PackActionInfo()

int SCR_EditorPreviewParams::PackActionInfo ( notnull SCR_BaseEditorAction action, notnull IEntity actionCompOwner )

inlinestaticprotected

Converts action instance into a replication friendly id

Parameters

action
actionCompOwner	entity which has editor actions components

Returns

action id with the id of the component from which it is from. If action is not found then this returns -1

Definition at line 159 of file SCR_EditorPreviewParams.c.

PropCompare()

bool SCR_EditorPreviewParams::PropCompare ( SCR_EditorPreviewParams prop, SSnapSerializerBase snapshot, ScriptCtx hint )

inlinestaticprotected

Definition at line 46 of file SCR_EditorPreviewParams.c.

SetTarget()

void SCR_EditorPreviewParams::SetTarget ( SCR_EditableEntityComponent target )

inlineprotected

Parameters

target

Definition at line 144 of file SCR_EditorPreviewParams.c.

SnapCompare()

bool SCR_EditorPreviewParams::SnapCompare ( SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx hint )

inlinestaticprotected

Definition at line 40 of file SCR_EditorPreviewParams.c.

Member Data Documentation

m_SourceAction

SCR_BaseEditorAction SCR_EditorPreviewParams::m_SourceAction

protected

local cache of the action which was the reason for creation of this param

Definition at line 24 of file SCR_EditorPreviewParams.c.

---

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

• scripts/Game/Editor/Containers/Rpc/SCR_EditorPreviewParams.c