effect_struct Struct Reference

#include <effects.h>

Data Fields
struct effect_struct *	next
char	name [MAX_BUF]
double	wind_chance
double	sprite_chance
struct effect_sprite *	sprites
struct effect_sprite *	sprites_end
struct effect_sprite_def *	sprite_defs
int	chance_total
long	wind
uint8	wind_blow_dir
uint32	delay
uint32	delay_ticks
int	max_sprites
double	wind_mod
int	sprites_per_move
struct effect_overlay *	overlay

---

Detailed Description

One effect definition in a linked list.

Definition at line 48 of file effects.h.

---

Field Documentation

int effect_struct::chance_total

Total chance value of all sprites in ::sprite_defs.

Definition at line 76 of file effects.h.

uint32 effect_struct::delay

Delay in ticks that must pass until another sprite can be created (regardless of the actual chance to create one). Default is 0.

Definition at line 87 of file effects.h.

uint32 effect_struct::delay_ticks

When a sprite was last created, in ticks.

Definition at line 90 of file effects.h.

int effect_struct::max_sprites

Maximum number of visible sprites, -1 for infinite (default).

Definition at line 93 of file effects.h.

char effect_struct::name[MAX_BUF]

Name of this effect.

Definition at line 54 of file effects.h.

struct effect_struct* effect_struct::next

Next effect in the list.

Definition at line 51 of file effects.h.

struct effect_overlay* effect_struct::overlay

Map overlay.

Definition at line 102 of file effects.h.

double effect_struct::sprite_chance

Controls how often to create a new sprite, should be a value between 0.0 (never) and 100.0 (always). Default is 60.0.

Definition at line 64 of file effects.h.

struct effect_sprite_def* effect_struct::sprite_defs

Linked list of sprite definitions.

Definition at line 73 of file effects.h.

struct effect_sprite* effect_struct::sprites

Start of the currently shown list of sprites.

Definition at line 67 of file effects.h.

struct effect_sprite* effect_struct::sprites_end

End of the currently shown list of sprites.

Definition at line 70 of file effects.h.

int effect_struct::sprites_per_move

Sprites per move, defaults to 1.

Definition at line 99 of file effects.h.

long effect_struct::wind

Wind modifier.

Definition at line 79 of file effects.h.

uint8 effect_struct::wind_blow_dir

Direction this sprite is getting blown into, one of Wind blow directions.

Definition at line 82 of file effects.h.

double effect_struct::wind_chance

Chance to change the way the wind blows, should be a value between 0.0 (always) and 1.0 (never). Default is 0.98.

Definition at line 59 of file effects.h.

double effect_struct::wind_mod

Wind blow modification (how strongly the wind blows to its direction).

Definition at line 96 of file effects.h.

---

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

• include/effects.h