UParticleModuleLocationSkelVertSurface::GetParticleLocation

Retrieve the position for the given socket index.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Particles/Location/ParticleModuleLocationSkelVertSurface.h

Include

#include "Particles/Location/ParticleModuleLocationSkelVertSurface.h"

Source

/Engine/Source/Runtime/Engine/Private/Particles/ParticleModules_Location.cpp

Syntax

bool GetParticleLocation
(
    FParticleEmitterInstance * Owner,
    FModuleLocationVertSurfaceInstancePayload * InstPayload,
    USkeletalMeshComponent * InSkelMeshComponent,
    int32 InPrimaryVertexIndex,
    FVector & OutPosition,
    FQuat & OutRotation,
    bool bSpawning
)

Remarks

Retrieve the position for the given socket index.

Returns

bool true if successful, false if not

Parameters

Parameter

Description

Owner

The particle emitter instance that is being setup

InSkelMeshComponent

The skeletal mesh component to use as the source

InPrimaryVertexIndex

The index of the only vertex (vert mode) or the first vertex (surface mode)

OutPosition

The position for the particle location

OutRotation

Optional orientation for the particle (mesh emitters)

bSpawning

When true and when using normal check on surfaces, will return false if the check fails.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss