USimpleConstructionScript

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/SimpleConstructionScript.h
Include #include "Engine/SimpleConstructionScript.h"

Syntax

class USimpleConstructionScript : public UObject

Constructors

  Type Name Description
Public function  

USimpleConstructionScript ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddNode ( USCS_Node* Node
)

 Adds this node to the root set
Public function void Called by the SCS editor to prepare for constructing editable components
Public function void Called by the SCS editor to clear all SCS editor component references
Public function void Create the map from names to SCS_Nodes to improve FindSCSNode performance during construction script execution
Public function USCS_Node *

CreateNode ( UClass* NewComponentClass,
FName NewComponentVariableName
)

 Creates a new SCS node using the given class to create the component template
Public function USCS_Node * Creates a new SCS node using the given component template instance
Public function void Called by the SCS editor to clean up after constructing editable components
Public function void

ExecuteScriptOnActor ( AActor* Actor,
const TInlineComponentArray< USceneComponent* >& NativeSceneComponents,
const FTransform& RootTransform,
const FRotationConversionCache* RootRelativeRotationCache,
bool bIsDefaultTransform,
ESpawnActorScaleMethod TransformScaleMethod
)

 Execute this script on the supplied actor, creating components
Public function Const USCS_Node * Find the parent node of this one. Returns NULL if node is not in tree or if is root
Public function Const USCS_Node *

FindSCSNode ( const FName InName
)

 Find the SCS_Node node by name and return it if found
Public function Const USCS_Node *

FindSCSNodeByGuid ( const FGuid Guid
)

 Find the SCS_Node node by name and return it if found
Public function void Ensures that all root node parent references are still valid and clears the reference if not
Public function Const FName

GenerateNewComponentName ( const UClass* ComponentClass,
FName DesiredName
)

 Helper function for generating a name for a new node, DesiredName can be used to optionally request a name, ComponentClass is mandatory
Public function Const const TArray< USCS_Node * > & Return all nodes in tree as a flat list
Public function Const UBlueprint * Return the Blueprint associated with this SCS instance
Public function Const AActor * Gets the SCS editor actor instance that's being used for component editing
Public function Const const USCS_Node * Provides read-only access to the default scene root node
Public function USCS_Node *  
Public function Const UClass * Return the Blueprint associated with this SCS instance
Public function Const UClass * Return the parent class of the SCS owner class
Public function Const FStaticMeshComponentBulkReregisterContext *  
Public function Const const TArray< USCS_Node * > & Provides read-only access to the root node set
Public function Const USceneComponent *

GetSceneRootComponentTemplate ( bool bShouldUseDefaultRoot,
USCS_Node** OutSCSNode
)

 Helper function to find the current scene root component template and optionally the owning SCS node
Public function Const bool Find out whether or not we're constructing components in the SCS editor
Public function void  
Public function Static void Helper method to register instanced components post-construction
Public function void Remove the map from names to SCS_Nodes
Public function void

RemoveNode ( USCS_Node* Node,
bool bValidateSceneRootNodes
)

 Remove this node from the script
Public function void Remove this node from the script and if it's the root, promote its first child to replace it
Public function void Saves the current state of SimpleConstructionScript and its nodes to the transaction buffer.
Public function void Called by the SCS editor to set the actor instance for component editing
Public function void Ensures that all nodes in the SCS have valid templates
Public function void Ensures that all nodes in the SCS have valid names for compilation/replication
Public function void Checks the root node set for scene components and ensures that it is valid (e.g. after a removal)

Overridden from UObject

  Type Name Description
Public function Virtual Const EDataValidationResult Returns Valid if this object has data validation rules set up for it and the data for this object is valid.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

Name Description
ComponentTemplateNameSuffix Suffix used for component template object name.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page