Skip to content

VfxLegacyPhysicsComponent

15.7

Class Documentation

Edit documentation

A physics component that carries the motion fields of a complex emitter: birth and over-life velocity, acceleration, drag, rotation and scale, the spawn shape, the emission mesh, force fields, terrain following and the emitter-frame overrides. It has its own running part, which moves the particles of a component emitter with these fields.

The client creates it only when a bin declares one. It never converts a complex emitter's motion fields into this component.

A field with the same name as a field of VfxEmitterDefinitionData has the meaning that page gives it. This page documents only what differs.

Properties

0x2d19f1a4

Flag = false
15.23
Edit documentation

Moves each particle into the emitter's frame after its position is set: the particle's transform is multiplied by the emitter's transform, rotation and translation both. The particles then move and turn with the emitter.

0x469f89dc

Flag = false
15.22
Type history (2 revisions)
  • 15.22 - 15.22 Bool
  • since 15.23 Flag
Edit documentation

Keeps lingering particles spinning. When set, the particle's rotation gets an extra angle of rate * 60 * t, where t is a per-particle time that is set only while the particle lingers, and rate is rotation0 or a switched-on replacement in Linger. That t is the time since the particle started to linger is not confirmed.

EmitterPosition

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

FlexInstanceScale

Pointer<FlexTypeFloat> = null
15.23
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

IsEmitterSpace

Flag = false
15.22
Type history (2 revisions)
  • 15.22 - 15.22 Bool
  • since 15.23 Flag
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

SpawnShape

Pointer<IVfxShape> = null
15.24
Edit documentation

Counterpart of SpawnShape on a complex emitter. The offset gets the same FlexShapeDefinition and system scaling and the same turn, and is added to the birth position. See IVfxShape.

acceleration

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

bindWeight

Embed<ValueFloat> = { "constantValue": 0, "dynamics": null }
15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

birthAcceleration

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

birthDrag

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

birthOrbitalVelocity

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

birthRotation0

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

birthRotationalAcceleration

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
15.10
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

birthRotationalVelocity

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
15.10
Edit documentation

Counterpart of birthRotationalVelocity0 on a complex emitter.

birthScale

Embed<ValueVector3> = { "constantValue": [1, 1, 1], "dynamics": null }
15.18
Edit documentation

Counterpart of birthScale0 on a complex emitter.

birthVelocity

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

drag

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

emissionMeshName

String = ""
16.13
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

emissionMeshScale

F32 = 1
16.13
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

flexScaleBirthScale

Pointer<FlexTypeFloat> = null
15.23
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

hasPostRotateOrientation

Flag = false
15.22
Type history (2 revisions)
  • 15.22 - 15.22 Bool
  • since 15.23 Flag
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

isDirectionOriented

Flag = false
15.22
Type history (2 revisions)
  • 15.22 - 15.22 Bool
  • since 15.23 Flag
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

isFollowingTerrain

Flag = false
15.12
Type history (2 revisions)
  • 15.12 - 15.22 Bool
  • since 15.23 Flag
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

particleIsLocalOrientation

Bool = false
Removed in 15.23 15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

postRotateOrientationAxis

Vec3 = [0, 0, 0]
15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

rotation0

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
15.22
Edit documentation

Spin rate over the particle's life. On a complex emitter it is an integrated value; here it is a plain ValueVector3. How the legacy running part reads it is not documented.

rotationOverride

Vec3 = [0, 0, 0]
15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

scale

Embed<ValueVector3> = { "constantValue": [1, 1, 1], "dynamics": null }
15.18
Edit documentation

Counterpart of scale0 on a complex emitter.

scaleOverride

Vec3 = [1, 1, 1]
15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

translationOverride

Vec3 = [0, 0, 0]
15.22
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

useEmissionMeshNormalForBirth

Flag = false
15.24
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

velocity

Embed<ValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

worldAcceleration

Embed<IntegratedValueVector3> = { "constantValue": [0, 0, 0], "dynamics": null }
Add documentation

No documentation available yet. Click "Add documentation" to contribute!