1. Epic GamesDeveloper
  3. UConstraintsScriptingLibrary

UConstraintsScriptingLibrary

This is a set of helper functions to access various parts of the Sequencer and Control Rig API via Python and Blueprints.

API > API/Runtime > API/Runtime/Constraints

This is a set of helper functions to access various parts of the Sequencer and Control Rig API via Python and Blueprints.

   
Name UConstraintsScriptingLibrary
Type class
Header File /Engine/Source/Runtime/Experimental/Animation/Constraints/Public/ConstraintsScripting.h
Include Path #include "ConstraintsScripting.h"

Syntax

UCLASS (Meta=(Transient, ScriptName="ConstraintsScriptingLibrary"), MinimalAPI)  
class UConstraintsScriptingLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddConstraint ( UWorld* InWorld,
UTransformableHandle* InParentHandle,
UTransformableHandle* InChildHandle,
UTickableTransformConstraint* InConstraint,
const bool bMaintainOffset
)

 Add Constraint to the system using the incoming parent and child handles with the specified type. ConstraintsScripting.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Constraints"

static UTickableTransformConstraint * CreateFromType ( UWorld* InWorld,
const ETransformConstraintType InType
)

 Create Constraint based on the specified type. ConstraintsScripting.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Constraints"

static UTransformableComponentHandle * CreateTransformableComponentHandle ( UWorld* InWorld,
USceneComponent* InSceneComponent,
const FName& InSocketName
)

 Create the transformable handle that deals with getting and setting transforms on this scene component ConstraintsScripting.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Constraints"

static UTransformableHandle * CreateTransformableHandle ( UWorld* InWorld,
UObject* InObject,
const FName& InAttachmentName
)

 Create the transformable handle that deals with getting and setting transforms on this object ConstraintsScripting.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Constraints"

static TArray< UTickableConstraint * > GetConstraintsArray ( UWorld* InWorld
)

 Get a copy of the constraints in the current world ConstraintsScripting.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Constraints"

static UConstraintsManager * GetManager ( UWorld* InWorld
)

 No longer used, the system will internally set up the outers for the handles and see UConstraintSubsystem for the delegates. ConstraintsScripting.h  

static bool RemoveConstraint ( UWorld* InWorld,
int32 InIndex
)

 Remove constraint at specified index ConstraintsScripting.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Constraints"

static bool RemoveThisConstraint ( UWorld* InWorld,
UTickableConstraint* InTickableConstraint
)

 Remove specified constraint ConstraintsScripting.h
  • BlueprintCallable
  • Category="Editor Scripting | Sequencer Tools | Control Rig | Constraints"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page