USkeletalMeshSocket

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USkeletalMeshSocket

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/SkeletalMeshSocket.h

Include

#include "Engine/SkeletalMeshSocket.h"

Syntax

class USkeletalMeshSocket : public UObject

Variables

Name Description

Public variable

bool

 

bForceAlwaysAnimated

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

Public variable

FName

 

BoneName

Public variable

FVector

 

RelativeLocation

Public variable

FRotator

 

RelativeRotation

Public variable

FVector

 

RelativeScale

Public variable

FName

 

SocketName

Defines a named attachment location on the USkeletalMesh.

Constructors

Name Description

Public function

USkeletalMeshSocket

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

AttachActor

(
    AActor* Actor,
    USkeletalMeshComponent* SkelCo...
)

Utility to associate an actor with a socket

Utility to associate an actor with a socket

Public function

void

 

CopyFrom

(
    const USkeletalMeshSocket* Oth...
)

Utility function to copy socket.

Public function Const

FTransform

 

GetSocketLocalTransform()

Returns FTransform of Socket local transform

Public function Const

FVector

 

GetSocketLocation

(
    const USkeletalMeshComponent* ...
)

Public function Const

bool

 

GetSocketMatrix

(
    FMatrix& OutMatrix,
    const USkeletalMeshComponent* ...
)

Utility that returns the current matrix for this socket.

Public function Const

bool

 

GetSocketMatrixWithOffset

(
    FMatrix& OutMatrix,
    USkeletalMeshComponent* SkelCo...,
    const FVector& InOffset,
    const FRotator& InRotation
)

Utility that returns the current matrix for this socket with an offset.

Public function Const

bool

 

GetSocketPositionWithOffset

(
    FVector& OutPosition,
    USkeletalMeshComponent* SkelCo...,
    const FVector& InOffset,
    const FRotator& InRotation
)

Utility that returns the current position of this socket with an offset.

Public function Const

FTransform

 

GetSocketTransform

(
    const USkeletalMeshComponent* ...
)

Utility that returns the current transform for this socket.

Public function

void

 

InitializeSocketFromLocation

(
    const USkeletalMeshComponent* ...,
    FVector WorldLocation,
    FVector WorldNormal
)

Sets BoneName, RelativeLocation and RelativeRotation based on closest bone to WorldLocation and WorldNormal

Public function

FSocketChang...

 

OnPropertyChanged()

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Classes

Name

Description

Public class

FSocketChangedEvent

Broadcasts a notification whenever the socket property has changed.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback