Ara
Download

Search or run a command

Jump to a section or open an Ara link.

Struct · Ara

VisualEffect

A GPU particle effect drawn at this entity. Presentation only: gameplay reads ara-vfx CPU events, never GPU particles. effect names a cooked library effect (campfire, sparks, depth_sparks, magic_swirl, smoke, muzzle_flash, rain, dust).

public struct VisualEffect : IComponent<VisualEffect>

Properties

TypeIndex

public static uint TypeIndex { get; }

Stable engine component index.

Fields

Effect

public string Effect;

Cooked library effect name.

Default: "campfire".

Scale

public float Scale;

Uniform size: the effect's shape, sprite sizes and speeds grow together (2 doubles a campfire's height and spread).

Range: [0.05, 50]. Default: 1.

Intensity

public float Intensity;

Brightness multiplier on the effect's emitted and lit colour; its opacity is unchanged. Lower it for effects that glow too hot under a scene's exposure.

Range: [0, 50]. Default: 1.

Methods

Access

public static ref VisualEffect Access(Entity entity, bool write);

No description yet.

Insert

public static void Insert(in Commands commands, Entity entity, in VisualEffect value);

No description yet.

Contains

public static bool Contains(Entity entity);

No description yet.