Class AdvancedParticleProperties
- Namespace
- Vintagestory.API.Common
- Assembly
- VintagestoryAPI.dll
Used to add a set of particle properties to a collectible.
[JsonObject(MemberSerialization.OptIn)]
public class AdvancedParticleProperties- Inheritance
-
AdvancedParticleProperties
Fields
HsvaColor (Optional) (Default: Random)
The Hue/Saturation/Value/Alpha for the color of the particle.
[JsonProperty]
public NatFloat[] HsvaColorField Value
- NatFloat[]
PosOffset (Optional) (Default: 0, 0, 0)
Offset from the blocks hitboxes top middle position
[JsonProperty]
public NatFloat[] PosOffsetField Value
- NatFloat[]
Properties
BlueEvolve (Optional) (Default: None)
A transforming Blue value.
[JsonProperty]
public EvolvingNatFloat BlueEvolve { get; set; }Property Value
Bounciness (Optional) (Default: 0)
The amount of velocity to be kept when this particle collides with something. Directional velocity is multipled by (-Bounciness * 0.65) on any collision.
[JsonProperty]
public float Bounciness { get; set; }Property Value
ColorByBlock (Optional) (Default: false)
Whether or not to color the particle by the block it's on.
[JsonProperty]
public bool ColorByBlock { get; set; }Property Value
DeathParticles (Optional) (Default: None)
More particles that spawn when this particle dies.
[JsonProperty]
public AdvancedParticleProperties[] DeathParticles { get; set; }Property Value
DieInAir (Optional) (Default: false)
Whether or not the particle dies in air.
[JsonProperty]
public bool DieInAir { get; set; }Property Value
DieInLiquid (Optional) (Default: false)
Whether or not the particle dies in water.
[JsonProperty]
public bool DieInLiquid { get; set; }Property Value
DieOnRainHeightmap (Optional) (Default: false)
If true, particle dies if it falls below the rain height at its given location
[JsonProperty]
public bool DieOnRainHeightmap { get; set; }Property Value
GravityEffect (Optional) (Default: 1)
The gravity effect on the particle.
[JsonProperty]
public NatFloat GravityEffect { get; set; }Property Value
GreenEvolve (Optional) (Default: None)
A transforming Green value.
[JsonProperty]
public EvolvingNatFloat GreenEvolve { get; set; }Property Value
LifeLength (Optional) (Default: 1)
The life length, in seconds, of the particle.
[JsonProperty]
public NatFloat LifeLength { get; set; }Property Value
OpacityEvolve (Optional) (Default: None)
A transforming opacity value.
[JsonProperty]
public EvolvingNatFloat OpacityEvolve { get; set; }Property Value
ParticleModel (Optional) (Default: Cube)
Sets the base model for the particle.
[JsonProperty]
public EnumParticleModel ParticleModel { get; set; }Property Value
Quantity (Optional) (Default: 1)
The quantity of the particles given.
[JsonProperty]
public NatFloat Quantity { get; set; }Property Value
RandomVelocityChange (Optional) (Default: false)
Allows each particle to randomly change its velocity over time.
[JsonProperty]
public bool RandomVelocityChange { get; set; }Property Value
RedEvolve (Optional) (Default: None)
A transforming Red value.
[JsonProperty]
public EvolvingNatFloat RedEvolve { get; set; }Property Value
SecondaryParticles (Optional) (Default: None)
More particles that spawn from this particle over time. See SecondarySpawnInterval to control rate.
[JsonProperty]
public AdvancedParticleProperties[] SecondaryParticles { get; set; }Property Value
SecondarySpawnInterval (Optional) (Default: 0)
The inverval that the SecondaryParticles spawn.
[JsonProperty]
public NatFloat SecondarySpawnInterval { get; set; }Property Value
SelfPropelled (Optional) (Default: false)
Whether or not the particle is self propelled.
[JsonProperty]
public bool SelfPropelled { get; set; }Property Value
Size (Optional) (Default: 1)
The size of the particles given.
[JsonProperty]
public NatFloat Size { get; set; }Property Value
SizeEvolve (Optional) (Default: 0)
A transforming Size value.
[JsonProperty]
public EvolvingNatFloat SizeEvolve { get; set; }Property Value
SwimOnLiquid (Optional) (Default: false)
Whether or not the particle floats on liquids.
[JsonProperty]
public bool SwimOnLiquid { get; set; }Property Value
TerrainCollision (Optional) (Default: true)
Whether or not the particle collides with the terrain.
[JsonProperty]
public bool TerrainCollision { get; set; }Property Value
Velocity (Optional) (Default: Random)
The velocity of the particles.
[JsonProperty]
public NatFloat[] Velocity { get; set; }Property Value
- NatFloat[]
VelocityEvolve (Optional) (Default: None)
A dynamic velocity value.
[JsonProperty]
public EvolvingNatFloat[] VelocityEvolve { get; set; }Property Value
VertexFlags (Optional) (Default: 0)
The level of glow in the particle.
[JsonProperty]
public int VertexFlags { get; set; }Property Value
WindAffectednes (Optional) (Default: 0)
How much the particles are affected by wind.
[JsonProperty]
public float WindAffectednes { get; set; }