1. Epic GamesDeveloper
  3. USkeletalMeshSocket

USkeletalMeshSocket

API > API/Runtime > API/Runtime/Engine

   
Name USkeletalMeshSocket
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Engine/SkeletalMeshSocket.h
Include Path #include "Engine/SkeletalMeshSocket.h"

Syntax

UCLASS (HideCategories=Object, HideCategories=Actor, BlueprintType, MinimalAPI)  
class USkeletalMeshSocket : public UObject

Inheritance Hierarchy

Classes

Name Remarks
FSocketChangedEvent Broadcasts a notification whenever the socket property has changed.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bForceAlwaysAnimated bool If true then the hierarchy of bones this socket is attached to will always be evaluated, even if it had previously been removed due to the current lod setting Engine/SkeletalMeshSocket.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Socket Parameters"
BoneName FName   Engine/SkeletalMeshSocket.h
  • Category="Socket Parameters"
  • VisibleAnywhere
  • BlueprintReadOnly
RelativeLocation FVector   Engine/SkeletalMeshSocket.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Socket Parameters"
RelativeRotation FRotator   Engine/SkeletalMeshSocket.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Socket Parameters"
RelativeScale FVector   Engine/SkeletalMeshSocket.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Socket Parameters"
SocketName FName Defines a named attachment location on the USkeletalMesh. Engine/SkeletalMeshSocket.h
  • Category="Socket Parameters"
  • VisibleAnywhere
  • BlueprintReadOnly

Protected

Name Type Remarks Include Path Unreal Specifiers
ChangedEvent FSocketChangedEvent Broadcasts a notification whenever the socket property has changed. Engine/SkeletalMeshSocket.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AttachActor ( AActor* Actor,
USkeletalMeshComponent* SkelComp
) const

 Utility to associate an actor with a socketUtility to associate an actor with a socket Engine/SkeletalMeshSocket.h  

void CopyFrom ( const USkeletalMeshSocket* OtherSocket
)

 Utility function to copy socket. Engine/SkeletalMeshSocket.h  

FTransform GetSocketLocalTransform()

 Returns FTransform of Socket local transform Engine/SkeletalMeshSocket.h
  • BlueprintCallable
  • Category="Socket Parameters"

FVector GetSocketLocation ( const USkeletalMeshComponent* SkelComp
) const

   Engine/SkeletalMeshSocket.h
  • BlueprintCallable
  • Category="Components|SkeletalMesh"

bool GetSocketMatrix ( FMatrix& OutMatrix,
const USkeletalMeshComponent* SkelComp
) const

 Utility that returns the current matrix for this socket. Engine/SkeletalMeshSocket.h  

bool GetSocketMatrixWithOffset ( FMatrix& OutMatrix,
USkeletalMeshComponent* SkelComp,
const FVector& InOffset,
const FRotator& InRotation
) const

 Utility that returns the current matrix for this socket with an offset. Engine/SkeletalMeshSocket.h  

bool GetSocketPositionWithOffset ( FVector& OutPosition,
USkeletalMeshComponent* SkelComp,
const FVector& InOffset,
const FRotator& InRotation
) const

 Utility that returns the current position of this socket with an offset. Engine/SkeletalMeshSocket.h  

FTransform GetSocketTransform ( const USkeletalMeshComponent* SkelComp
) const

 Utility that returns the current transform for this socket. Engine/SkeletalMeshSocket.h  

void InitializeSocketFromLocation ( const USkeletalMeshComponent* SkelComp,
FVector WorldLocation,
FVector WorldNormal
)

 Sets BoneName, RelativeLocation and RelativeRotation based on closest bone to WorldLocation and WorldNormal Engine/SkeletalMeshSocket.h
  • BlueprintCallable
  • Category="Components|SkeletalMesh"

FSocketChangedEvent & OnPropertyChanged()

   Engine/SkeletalMeshSocket.h  

void SetSocketLocalTransform ( FTransform InTransform
)

 Sets the relative transform parameters of the socket to the given local FTransform Engine/SkeletalMeshSocket.h
  • BlueprintCallable
  • Category="Socket Parameters"

void SetSocketParent ( USkeletalMesh* InSkeletalMesh,
FName InBoneName
)

 Change the sockets parent to a new bone. The skeleton is used to validate that the bone exists Engine/SkeletalMeshSocket.h
  • BlueprintCallable
  • Category="Socket Parameters"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Engine/SkeletalMeshSocket.h  

virtual void Serialize ( FArchive& Ar
)

   Engine/SkeletalMeshSocket.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page