Simple particle, based on mover. More...

Inheritance diagram for Particles.SimpleParticle:

Public Member Functions
	SimpleParticle ()
	Create a default non-wrapping particle. More...

bool	IsDead ()
	Check if the particle is dead. More...

Public Member Functions inherited from Forces.SimpleMover
	SimpleMover ()
	Create a simple wrapping mover with a circle mesh. More...

	SimpleMover (WrapModeEnum wrapMode)
	Create a simple mover with a custom wrap mode and a circle mesh. More...

virtual void	ApplyForce (Vector2 force)
	Apply force on mover. More...

virtual void	ApplyAngularForce (float force)
	Apply angular force on mover. More...

virtual void	ApplyFriction (float coef)
	Apply friction on mover. More...

virtual void	ApplyAngularFriction (float coef)
	Apply angular friction on mover. More...

virtual void	ApplyDrag (float coef)
	Apply drag on mover. More...

virtual void	ApplyDamping (float coef)
	Apply damping on mover. More...

Public Attributes
float	Lifespan = 2
	Lifespan More...

bool	LifespanAsAlpha = true
	Lifespan as alpha More...

Vector2	InitialOffset = Vector2.Zero
	Initial offset More...

Public Attributes inherited from Forces.SimpleMover
Vector2	Velocity = Vector2.Zero
	Current velocity More...

Vector2	Acceleration = Vector2.Zero
	Current acceleration More...

float	AngularVelocity
	Current angular velocity More...

float	AngularAcceleration
	Current angular acceleration More...

float	MaxVelocity = 10
	Max velocity More...

float	MaxAngularVelocity = 0.1f
	Max angular velocity More...

float	Mass = 1
	Mass More...

WrapModeEnum	WrapMode
	Wrapping mode More...

bool	DisableForces
	Disable forces More...

bool	SyncRotationOnVelocity
	Synchronize rotation on velocity More...

SimpleMesh	Mesh
	Mesh More...

Protected Member Functions
byte	GetLifespanAlphaValue ()
	Get lifespan alpha value. More...

Protected Member Functions inherited from Forces.SimpleMover
virtual void	UpdateAcceleration ()
	Update acceleration value. More...

Additional Inherited Members
Public Types inherited from Forces.SimpleMover
enum class	WrapModeEnum { Wrap , Bounce , None }
	Wrapping mode enum. More...

Protected Attributes inherited from Forces.SimpleMover
CollisionShape2D	collisionShape2D
	Collision shape More...

Properties inherited from Forces.SimpleMover
bool	Drawing `[get, set]`
	Draw mesh More...

Vector2	MeshSize `[get, set]`
	Mesh size More...

float	Radius `[get, set]`
	Mesh radius More...

Detailed Description

Simple particle, based on mover.

Definition at line 12 of file SimpleParticle.cs.

Constructor & Destructor Documentation

◆ SimpleParticle()

Particles.SimpleParticle.SimpleParticle ( )

inline

Create a default non-wrapping particle.

Definition at line 28 of file SimpleParticle.cs.

         {
             WrapMode = WrapModeEnum.None;
         }

Member Function Documentation

◆ GetLifespanAlphaValue()

byte Particles.SimpleParticle.GetLifespanAlphaValue ( )

inlineprotected

Get lifespan alpha value.

Returns: Alpha byte value

Definition at line 46 of file SimpleParticle.cs.

         {
             return (byte)Mathf.Clamp(Lifespan / initialLifespan * 255, 0, 255);
         }

◆ IsDead()

bool Particles.SimpleParticle.IsDead ( )

inline

Check if the particle is dead.

Returns: True/False

Definition at line 37 of file SimpleParticle.cs.

         {
             return Lifespan <= 0;
         }

Member Data Documentation

◆ InitialOffset

Vector2 Particles.SimpleParticle.InitialOffset = Vector2.Zero

Initial offset

Definition at line 21 of file SimpleParticle.cs.

◆ Lifespan

float Particles.SimpleParticle.Lifespan = 2

Lifespan

Definition at line 15 of file SimpleParticle.cs.

◆ LifespanAsAlpha

bool Particles.SimpleParticle.LifespanAsAlpha = true

Lifespan as alpha

Definition at line 18 of file SimpleParticle.cs.

The documentation for this class was generated from the following file:

scripts/particles/SimpleParticle.cs

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members