Navigation
Unreal Engine C++ API Reference > Runtime > Engine > Particles > Orbit
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UParticleModule
- UParticleModuleOrbitBase
- UParticleModuleOrbit
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Particles/Orbit/ParticleModuleOrbit.h |
| Include | #include "Particles/Orbit/ParticleModuleOrbit.h" |
Syntax
class UParticleModuleOrbit : public UParticleModuleOrbitBase
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TEnumAsByte< enum EOrbitChainMode > | ChainMode | Orbit modules will chain together in the order they appear in the module stack. |
 |
FRawDistributionVector | OffsetAmount | The amount to offset the sprite from the particle position. |
 |
FOrbitOptions | OffsetOptions | The options associated with the OffsetAmount look-up. |
 |
FRawDistributionVector | RotationAmount | The amount (in 'turns') to rotate the offset about the particle position. |
 |
FOrbitOptions | RotationOptions | The options associated with the RotationAmount look-up. |
 |
FRawDistributionVector | RotationRateAmount | The rate (in 'turns') at which to rotate the offset about the particle positon. |
 |
FOrbitOptions | RotationRateOptions | The options associated with the RotationRateAmount look-up. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UParticleModuleOrbit
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Initializes the default values for this property |
Overridden from UParticleModule
| Type | Name | Description | |
|---|---|---|---|
  |
void | CompileModule
(
FParticleEmitterBuildInfo& EmitterInfo |
Called once to compile the effects of this module on runtime simulation. |
  |
bool | IsValidForLODLevel
(
UParticleLODLevel* LODLevel, |
Returns true if the module is valid for the provided LOD level. |
  |
uint32 | RequiredBytes
(
UParticleModuleTypeDataBase* TypeData |
Returns the number of bytes that the module requires in the particle payload block. |
  |
uint32 | Returns the number of bytes the module requires in the emitters 'per-instance' data block. | |
  |
void | Spawn
(
FParticleEmitterInstance* Owner, |
Called on a particle that is freshly spawned by the emitter. |
  |
void | Update
(
FParticleEmitterInstance* Owner, |
Called on a particle that is being updated by its emitter. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |
  |
void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |