mAnimationName
String = "" The animation a skinned mesh plays: an .anm path, or the bare name of a clip.
Ignored when mAnimationVariants has entries, and never loaded for a static mesh.
VfxMeshDefinitionData
Class Documentation
Edit documentationWhich mesh a mesh primitive draws, how it is animated and which of its submeshes show.
Choosing the mesh. The fields are tried in a fixed order when the emitter's definition loads, and the first that loads wins:
- A skinned mesh, when both
mMeshNameandmMeshSkeletonNameare set and neither is itsdoesnotexist.*placeholder. It is all or nothing: one name without the other loads no skinned mesh. - A static mesh from
mSimpleMeshName, when it ends in.scb. - A static mesh from
mSimpleMeshName, when it ends in.tmeshor.gmesh.
A skinned pair therefore overrides mSimpleMeshName entirely. mSimpleMeshName is the
only field tested by extension, and any other extension loads nothing, .sco included.
The animation fields apply only to a skinned mesh.
Properties
mAnimationVariants
List<String> = [] Alternative animations. When the list has entries, one is picked at random, each with
equal chance, and replaces mAnimationName.
The pick happens once, when the effect's definition loads, not per particle and not per effect instance. Every instance plays the same animation until the definitions are loaded again.
mLockMeshToAttachment
Bool = false Places the mesh on the unit's attachment instead of on the particle. Read only by VfxPrimitiveAttachedMesh, which describes the effect. Other mesh primitives ignore it.
mMeshName
String = "" Path of a skinned mesh (.skn). Needs mMeshSkeletonName to load, and takes
precedence over mSimpleMeshName when it does.
mMeshSkeletonName
String = "" Path of the skeleton (.skl) for mMeshName. Without it the skinned mesh does not load.
mSimpleMeshName
String = "" Path of a static mesh: .scb, .tmesh or .gmesh. Used only when no skinned mesh
loaded. Any other extension is ignored without an error.
mSubmeshesToDraw
List<Hash> = [] Names of the submeshes to draw. An empty list draws them all. Names are matched against
the mesh's own submesh names, and a mesh can have at most 32 addressable submeshes.
How the list combines with mSubmeshesToDrawAlways depends on the primitive: see
VfxPrimitiveMesh and
VfxPrimitiveAttachedMesh.
mSubmeshesToDrawAlways
List<Hash> = [] Submeshes drawn in addition to mSubmeshesToDraw. On an attached mesh they are added
after the unit's own visibility, so they show even while the unit hides them.