Class ParticleStaticMeshShapeOptions

constructor

• new ParticleStaticMeshShapeOptions(
      type?: EnumValue<ParticleEmitterMeshType>,
      isSequentiallyEmitted?: boolean,
      mesh?: Mesh | ResourceHandle<Mesh>,
      isInternalConstructor?: boolean,
  ): ParticleStaticMeshShapeOptions

  Parameters

  • Optionaltype: EnumValue<ParticleEmitterMeshType>
  • OptionalisSequentiallyEmitted: boolean
  • Optionalmesh: Mesh | ResourceHandle<Mesh>
  • OptionalisInternalConstructor: boolean

  Returns ParticleStaticMeshShapeOptions

isSequentiallyEmitted

• get isSequentiallyEmitted(): boolean

  Returns boolean

• set isSequentiallyEmitted(value: boolean): void

  Parameters

  • value: boolean

  Returns void

mesh

• get mesh(): Mesh

  Mesh to spawn particles on. Must at least contain per-vertex position data encoded as 3D float vectors. Can optionally contain per-vertex normals encoded as 3D float vectors or as 4-byte unsigned-normalized format.

  Returns Mesh

• set mesh(value: Mesh): void

  Mesh to spawn particles on. Must at least contain per-vertex position data encoded as 3D float vectors. Can optionally contain per-vertex normals encoded as 3D float vectors or as 4-byte unsigned-normalized format.

  Parameters

  • value: Mesh

  Returns void

meshHandle

• get meshHandle(): ResourceHandle<Mesh>

  Mesh to spawn particles on. Must at least contain per-vertex position data encoded as 3D float vectors. Can optionally contain per-vertex normals encoded as 3D float vectors or as 4-byte unsigned-normalized format.

  Returns ResourceHandle<Mesh>

• set meshHandle(value: Mesh | ResourceHandle<Mesh>): void

  Parameters

  • value: Mesh | ResourceHandle<Mesh>

  Returns void

type

• get type(): EnumValue<ParticleEmitterMeshType>

  Determines from which portion of the mesh are the particles emitted from.

  Returns EnumValue<ParticleEmitterMeshType>

• set type(value: EnumValue<ParticleEmitterMeshType>): void

  Parameters

  • value: EnumValue<ParticleEmitterMeshType>

  Returns void

markAsDirty

• markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void

  Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action: () => void): void

  Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

  Parameters

  • action: () => void

    The scope where the object is modified.

  Returns void

ReadonlyonDirty