SCR_EditorPreviewParams Interface Reference

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

Public Member Functions
void	GetWorldTransform (out vector outTransform[4])
	Get world transformation matrix.
bool	Deserialize ()
	Convert replication-friendly values to actual variables.
void	SetTarget (SCR_EditableEntityComponent target)

Static Public 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 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)
	Create params for entity placement.
static SCR_EditorPreviewParams	CreateParamsFromPreview (SCR_PreviewEntityEditorComponent previewManager, SCR_EditableEntityComponent parent=null, bool parentChanged=false)
	Create params packet for network transmission.

Public Attributes
SCR_EditableEntityComponent	m_Parent
RplId	m_ParentID = RplId.Invalid()
bool	m_bParentChanged
RplId	m_TargetRplID = RplId.Invalid()
EntityID	m_TargetStaticID
SCR_EditableEntityComponent	m_Target
EEditableEntityInteraction	m_TargetInteraction
vector	m_vTransform [4]
vector	m_Offset
bool	m_bIsUnderwater
EEditorTransformVertical	m_VerticalMode
EEditorPlacingFlags	m_PlacingFlags
SCR_EditableEntityComponent	m_CurrentLayer

Detailed Description

Network packet of variables for entity placing and transformation.

Member Function Documentation

CreateParams()

static 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 )

static

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

CreateParamsFromPreview()

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

static

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

Decode()

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

static

Deserialize()

bool SCR_EditorPreviewParams.Deserialize

(

)

Convert replication-friendly values to actual variables.

Returns

True if the deserialization was completed successfully

Encode()

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

static

Extract()

static bool SCR_EditorPreviewParams.Extract ( SCR_EditorPreviewParams prop, ScriptCtx hint, SSnapSerializerBase snapshot )

static

GetWorldTransform()

void SCR_EditorPreviewParams.GetWorldTransform

(

out vector

outTransform[4]

)

Get world transformation matrix.

If offset is used, it will be applied to it.

Parameters

[out]

outTransform

Variable to be filled with transformation matrix

Inject()

static bool SCR_EditorPreviewParams.Inject ( SSnapSerializerBase snapshot, ScriptCtx hint, SCR_EditorPreviewParams prop )

static

PropCompare()

static bool SCR_EditorPreviewParams.PropCompare ( SCR_EditorPreviewParams prop, SSnapSerializerBase snapshot, ScriptCtx hint )

static

SetTarget()

void SCR_EditorPreviewParams.SetTarget

(

SCR_EditableEntityComponent

target

)

Parameters

target

SnapCompare()

static bool SCR_EditorPreviewParams.SnapCompare ( SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx hint )

static

Member Data Documentation

m_bIsUnderwater

bool SCR_EditorPreviewParams.m_bIsUnderwater

m_bParentChanged

bool SCR_EditorPreviewParams.m_bParentChanged

m_CurrentLayer

SCR_EditableEntityComponent SCR_EditorPreviewParams.m_CurrentLayer

m_Offset

vector SCR_EditorPreviewParams.m_Offset

m_Parent

SCR_EditableEntityComponent SCR_EditorPreviewParams.m_Parent

m_ParentID

RplId SCR_EditorPreviewParams.m_ParentID = RplId.Invalid()

m_PlacingFlags

EEditorPlacingFlags SCR_EditorPreviewParams.m_PlacingFlags

m_Target

SCR_EditableEntityComponent SCR_EditorPreviewParams.m_Target

m_TargetInteraction

EEditableEntityInteraction SCR_EditorPreviewParams.m_TargetInteraction

m_TargetRplID

RplId SCR_EditorPreviewParams.m_TargetRplID = RplId.Invalid()

m_TargetStaticID

EntityID SCR_EditorPreviewParams.m_TargetStaticID

m_VerticalMode

EEditorTransformVertical SCR_EditorPreviewParams.m_VerticalMode

m_vTransform

vector SCR_EditorPreviewParams.m_vTransform[4]

---

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

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