1. Epic GamesDeveloper
  3. FPhysicsControlNameRecords

FPhysicsControlNameRecords

All the controls and body modifiers we create get given names, so we can keep a record in a form that will be useful to users.

API > API/Plugins > API/Plugins/PhysicsControl

All the controls and body modifiers we create get given names, so we can keep a record in a form that will be useful to users. The three general uses are:

All controls or modifiers

The type of control - the obvious ones are "world space" and "parent space", but users might make others

Sets of control/modifiers - the obvious ones are limbs (e.g. a set of world-space controls on the leg) but users might want to make other sets - e.g. "UpperBody"

   
Name FPhysicsControlNameRecords
Type struct
Header File /Engine/Plugins/Experimental/PhysicsControl/Source/PhysicsControl/Public/PhysicsControlNameRecords.h
Include Path #include "PhysicsControlNameRecords.h"

Syntax

struct FPhysicsControlNameRecords

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
BodyModifierSets TMap< FName, TArray< FName > > All the body modifiers we've created, arranged by set name. PhysicsControlNameRecords.h  
ControlSets TMap< FName, TArray< FName > > All the control sets we've created, arranged by set name. PhysicsControlNameRecords.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBodyModifier ( FName Name,
FName SetName
)

 Adds Name to SetName as well as adding it to the set "All" PhysicsControlNameRecords.h  

void AddBodyModifier ( FName Name,
const TArray< FName >& SetNames
)

 Adds Name to SetNames as well as adding it to the set "All" PhysicsControlNameRecords.h  

void AddBodyModifiers ( const TArray< FName >& BodyModifierNames,
const FName SetName
)

 Adds a collection of Names to SetName as well as adding them to the set "All" PhysicsControlNameRecords.h  

void AddControl ( FName Name,
FName SetName
)

 Adds Name to SetName as well as adding it to the set "All" PhysicsControlNameRecords.h  

void AddControl ( FName Name,
const TArray< FName >& SetNames
)

 Adds Name to SetNames as well as adding it to the set "All" PhysicsControlNameRecords.h  

void AddControls ( const TArray< FName >& ControlNames,
const FName SetName
)

 Adds a collection of Names to SetName as well as adding them to the set "All" PhysicsControlNameRecords.h  

const TArray< FName > & GetBodyModifierNamesInSet ( FName SetName
) const

   PhysicsControlNameRecords.h  

const TArray< FName > & GetControlNamesInSet ( FName SetName
) const

   PhysicsControlNameRecords.h  

void RemoveBodyModifier ( FName Name
)

 Removes Name from all Sets PhysicsControlNameRecords.h  

void RemoveControl ( FName Name
)

 Removes Name from all Sets PhysicsControlNameRecords.h  

void Reset()

 Remove all control and modifier sets. PhysicsControlNameRecords.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page