1. Epic GamesDeveloper
  3. URCBehaviour

URCBehaviour

Base class for remote control behaviour.

API > API/Plugins > API/Plugins/RemoteControlLogic

Base class for remote control behaviour.

Behaviour is container for:

  • Set of behaviour conditions
  • And associated actions which should be executed if that is passed the behaviour

Behaviour can be extended in Blueprints or CPP classes

   
Name URCBehaviour
Type class
Header File /Engine/Plugins/VirtualProduction/RemoteControl/Source/RemoteControlLogic/Public/Behaviour/RCBehaviour.h
Include Path #include "Behaviour/RCBehaviour.h"

Syntax

UCLASS (BlueprintType)  
class URCBehaviour : public UObject

Inheritance Hierarchy

Derived Classes

URCBehaviour derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

URCBehaviour()

   Behaviour/RCBehaviour.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActionContainer TObjectPtr< URCActionContainer > Action container which is associated with current behaviour Behaviour/RCBehaviour.h  
BehaviourNodeClass TSubclassOf< URCBehaviourNode > Associated cpp behaviour Behaviour/RCBehaviour.h  
bExecuteBehavioursDuringPreChange bool Indicates whether we want a behavour to trigger during live scrubbing of values. Behaviour/RCBehaviour.h  
bIsEnabled bool Whether this Behaviour is currently enabled. Behaviour/RCBehaviour.h  
ControllerWeakPtr TWeakObjectPtr< URCController > Reference to controller virtual property with this behaviour Behaviour/RCBehaviour.h  
Id FGuid Behaviour Id Behaviour/RCBehaviour.h  
OverrideBehaviourBlueprintClassPath FSoftClassPath Class path to associated blueprint class behaviour Behaviour/RCBehaviour.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedBehaviourNode TObjectPtr< URCBehaviourNode > Cached behaviour node Behaviour/RCBehaviour.h
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual URCAction * AddAction ( const TSharedRef< const FRemoteControlField > InRemoteControlField
)

 Add a Logic action using a remote control field as input Behaviour/RCBehaviour.h  

virtual URCAction * AddAction ()

 Add a Logic action as an identity action. Behaviour/RCBehaviour.h  

virtual URCAction * AddAction ( FName InFieldId
)

 Add a Logic action as an identity action. Behaviour/RCBehaviour.h  

virtual bool CanHaveActionForField ( const TSharedPtr< FRemoteControlField > InRemoteControlField
) const

 Whether we can create an action pertaining to a given remote control field for the current behaviour Behaviour/RCBehaviour.h  

virtual URCAction * DuplicateAction ( URCAction* InAction,
URCBehaviour* InBehaviour
)

 Duplicates an Action belonging to us into a given target behaviour Behaviour/RCBehaviour.h  

void Execute()

 Execute the behaviour Behaviour/RCBehaviour.h  

const FText & GetBehaviorDescription()

 Get Description for this Behaviour Behaviour/RCBehaviour.h  

URCBehaviourNode * GetBehaviourNode()

 It created the node if it called first time If BehaviourNodeClass changes it creates new instance Or just return cached one Behaviour/RCBehaviour.h  

UBlueprint * GetBlueprint()

 Return blueprint instance associated with behaviour if exists Behaviour/RCBehaviour.h  

const FText & GetDisplayName()

 Get Display Name for this Behaviour Behaviour/RCBehaviour.h  

int32 GetNumActions()

 Get number of action associated with behaviour Behaviour/RCBehaviour.h  

UClass * GetOverrideBehaviourBlueprintClass()

 Return blueprint class associated with behaviour if exists Behaviour/RCBehaviour.h  

bool HasAction ( const URCAction* InAction
) const

   Behaviour/RCBehaviour.h  

virtual void Initialize()

 Initialize behaviour functionality. Called just once when created by a controller. Behaviour/RCBehaviour.h  

virtual void NotifyActionValueChanged ( URCAction* InChangedAction
)

 Called when an action value changed Behaviour/RCBehaviour.h  

void SetOverrideBehaviourBlueprintClass ( UBlueprint* InBlueprint
)

 Set blueprint class for this behaviour Behaviour/RCBehaviour.h  

virtual bool SupportPropertyId()

 Whether the behaviour support property id, by default true because of the OnModify Behaviour Behaviour/RCBehaviour.h  

virtual void UpdateEntityIds ( const TMap< FGuid, FGuid >& InEntityIdMap
)

 Called internally when entity Ids are renewed. Behaviour/RCBehaviour.h  

void UpdateEntityUsage ( const URCController* InController,
TMap< FGuid, TSet< UObject* > >& InEntityToBehavior
) const

   Behaviour/RCBehaviour.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ExecuteInternal ( const TSet< TObjectPtr< URCAction > >& InActionsToExecute
)

 Execute all the action if not provided a valid Action otherwise will only execute the given action Behaviour/RCBehaviour.h  

void ExecuteSingleAction ( URCAction* InAction
)

 Execute the given Action Behaviour/RCBehaviour.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page