VfxShimmerPrimitiveMeshBeam

Inheritance 3 ancestors · 6 siblings

IVfxShimmerGeometry&VfxPrimitiveBase
- VfxShimmerPrimitiveBase
  - VfxPrimitiveLaser
  - VfxPrimitiveRibbon
  - VfxShimmerPrimitiveMeshBase2
  - VfxShimmerPrimitiveMeshBeamcurrent
  - VfxShimmerPrimitiveNonRenderable
  - VfxShimmerPrimitiveQuad
  - VfxShimmerPrimitiveQuadBase (removed in patch 16.21)1

Class Documentation

A mesh stretched along a beam. For each particle, the client places Mesh between the beam's source and target, and scales the mesh along its local Z by the beam length divided by the mesh's Z extent.

The source is the system's position and the target is the effect's target position, each moved by the offsets in Beam; see VfxShimmerMeshBeamDefinitionData. The particle's position does not place either end. The mesh beam has no facing mode.

Properties

Beam

Embed<VfxShimmerMeshBeamDefinitionData>

Default value

{
  "mLocalSpaceTargetOffset": [0, 0, 0],
  "mLocalSpaceSourceOffset": [0, 0, 0]
}

Documentation Edit documentation

The two endpoint offsets. See VfxShimmerMeshBeamDefinitionData.

Mesh

Embed<VfxMeshDefinitionData>

Default value

{
  "mAnimationVariants": [],
  "mMeshName": "",
  "mMeshSkeletonName": "",
  "mSubmeshesToDrawAlways": [],
  "mSimpleMeshName": "",
  "mSubmeshesToDraw": [],
  "mLockMeshToAttachment": false,
  "mAnimationName": ""
}

Documentation Edit documentation

The mesh to stretch. See VfxMeshDefinitionData.