SCR_EditableEntityInteraction Interface Reference

Inheritance diagram for SCR_EditableEntityInteraction:

Public Member Functions
sealed bool	CanSetParent (SCR_EditableEntityComponent parentEntity, EEditableEntityInteractionFlag interactionFlags=int.MAX)
	Check if the entity can be moved to intended parent.
bool	CanSetParent (EEditableEntityType parentType, EEditableEntityFlag parentFlags, EEditableEntityInteractionFlag interactionFlags=int.MAX)
	Check if the entity can be moved to a parent with given params.
bool	CanSetParent (SCR_EditableEntityComponent parentEntity, EEditableEntityType parentType, EEditableEntityFlag parentFlags, EEditableEntityInteractionFlag interactionFlags=int.MAX)
	Check if the entity can be moved to a parent with given params.
bool	CanCreateParentFor (EEditableEntityType newLayerType, EEditableEntityFlag newLayerFlags, SCR_EditableEntityComponent parentEntity, bool CheckParentEntity=true)
	Check if new layer can be created for entity.

Static Public Attributes
static const int	ROOT = -1

Protected Attributes
bool	m_bCanRefParent

Member Function Documentation

CanCreateParentFor()

bool SCR_EditableEntityInteraction.CanCreateParentFor	(	EEditableEntityType	newLayerType,
		EEditableEntityFlag	newLayerFlags,
		SCR_EditableEntityComponent	parentEntity,
		bool	CheckParentEntity = true
	)

Check if new layer can be created for entity.

Parameters

EEditableEntityType	new layer type
newLayerFlags	new layer m_Flags
parentEntity	parent entity
CheckParentEntity	if should check if new layer can be added to parent

Returns

bool if the given layer can be created for the entity

CanSetParent() [1/3]

bool SCR_EditableEntityInteraction.CanSetParent	(	EEditableEntityType	parentType,
		EEditableEntityFlag	parentFlags,
		EEditableEntityInteractionFlag	interactionFlags = int::MAX
	)

Check if the entity can be moved to a parent with given params.

Parameters

parentType	Type of the new parent, use SCR_EditableEntityInteraction.ROOT if it§s root of editable entities.
parentFlags	Flags of the new parent \params interactionFlags Flags defining details about the interaction (all are enabled if undefined)

Returns

True if interaction is possible

Implemented in SCR_EditableWaypointInteraction, SCR_EditableCharacterInteraction, and SCR_EditableGroupInteraction.

CanSetParent() [2/3]

sealed bool SCR_EditableEntityInteraction.CanSetParent	(	SCR_EditableEntityComponent	parentEntity,
		EEditableEntityInteractionFlag	interactionFlags = int::MAX
	)

Check if the entity can be moved to intended parent.

Parameters

parentEntity

New parent. Null when evaluating root. \params interactionFlags Flags defining details about the interaction (all are enabled if undefined)

Returns

True if interaction is possible

CanSetParent() [3/3]

bool SCR_EditableEntityInteraction.CanSetParent	(	SCR_EditableEntityComponent	parentEntity,
		EEditableEntityType	parentType,
		EEditableEntityFlag	parentFlags,
		EEditableEntityInteractionFlag	interactionFlags = int::MAX
	)

Check if the entity can be moved to a parent with given params.

Only called if m_bCanRefParent is set to true

Parameters

parentEntity	New parent. Null when evaluating root.
parentType	Type of the new parent, use SCR_EditableEntityInteraction.ROOT if it§s root of editable entities.
parentFlags	Flags of the new parent \params interactionFlags Flags defining details about the interaction (all are enabled if undefined)

Returns

True if interaction is possible

Implemented in SCR_EditableAttachableEntityInteraction.

Member Data Documentation

m_bCanRefParent

bool SCR_EditableEntityInteraction.m_bCanRefParent

protected

ROOT

const int SCR_EditableEntityInteraction.ROOT = -1

static

---

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

• Game/Editor/Containers/Interactions/SCR_EditableEntityInteraction.c