Table of Contents

Class EntityCubeParticles

Namespace
Vintagestory.API.Common
Assembly
VintagestoryAPI.dll

Open in GitHub

public class EntityCubeParticles : CollectibleParticleProperties, IParticlePropertiesProvider
Inheritance
EntityCubeParticles
Implements
Inherited Members
Extension Methods

Constructors

EntityCubeParticles() 

public EntityCubeParticles()

EntityCubeParticles(IWorldAccessor, long, Vec3d, float, int, float, float) 

public EntityCubeParticles(IWorldAccessor world, long entityId, Vec3d particlePos, float radius, int quantity, float minScale, float maxScale)

Parameters

world IWorldAccessor
entityId long
particlePos Vec3d
radius float
quantity int
minScale float
maxScale float

Fields

maxScale 

public float maxScale

Field Value

float

minScale 

public float minScale

Field Value

float

particlePos 

public Vec3d particlePos

Field Value

Vec3d

quantity 

public int quantity

Field Value

int

radius 

public float radius

Field Value

float

Properties

DieInLiquid

Whether the particle should despawn when in contact with liquids

public override bool DieInLiquid { get; }

Property Value

bool

LifeLength

How long the particle should live (default = 1)

public override float LifeLength { get; }

Property Value

float

ParticleModel

Cube or Quad?

public override EnumParticleModel ParticleModel { get; }

Property Value

EnumParticleModel

Pos

Position in the world where the particle should spawn

public override Vec3d Pos { get; }

Property Value

Vec3d

Quantity

How many particles should spawn? For every particle spawned, all of belows methods are called once. E.g. if quantity is 10, GetPos(), GetVelocity(),... is called 10 times.

public override float Quantity { get; }

Property Value

float

SecondaryParticles

The secondary particle properties. Secondary particles are particles that are emitted from an in-flight particle.

public override IParticlePropertiesProvider[] SecondaryParticles { get; }

Property Value

IParticlePropertiesProvider[]

Size

Size of the particle

public override float Size { get; }

Property Value

float

VertexFlags

See also VertexFlags

public override int VertexFlags { get; }

Property Value

int

Methods

FromBytes(BinaryReader, IWorldAccessor)

For reading from the network

public override void FromBytes(BinaryReader reader, IWorldAccessor resolver)

Parameters

reader BinaryReader
resolver IWorldAccessor

GetRgbaColor(ICoreClientAPI)

The particles Rgba Color

public override int GetRgbaColor(ICoreClientAPI capi)

Parameters

capi ICoreClientAPI

Returns

int

GetVelocity(Vec3d)

In what direction should the particle fly/fall

public override Vec3f GetVelocity(Vec3d pos)

Parameters

pos Vec3d

Returns

Vec3f

Init(ICoreAPI)

Called before the particle provider is used for particle creation

public override void Init(ICoreAPI api)

Parameters

api ICoreAPI

ToBytes(BinaryWriter)

For sending over the network

public override void ToBytes(BinaryWriter writer)

Parameters

writer BinaryWriter