Atrinik Client  4.0
Data Fields
effect_sprite_def Struct Reference

#include <effects.h>

Data Fields

struct effect_sprite_defnext
 
int id
 
char * name
 
double weight
 
double weight_mod
 
int chance
 
uint32_t delay
 
uint8_t wind
 
double wiggle
 
double wind_mod
 
int x
 
int y
 
int xpos
 
int ypos
 
uint8_t reverse
 
double y_rndm
 
double x_mod
 
double y_mod
 
uint8_t x_check_mod
 
uint8_t y_check_mod
 
uint8_t kill_side_left
 
uint8_t kill_side_right
 
uint16_t zoom
 
uint8_t warp_sides
 
uint32_t ttl
 
char sound_file [MAX_BUF]
 
uint8_t sound_volume
 

Detailed Description

Sprite definition; holds various settings of a single sprite.

Definition at line 146 of file effects.h.

Field Documentation

int effect_sprite_def::chance

Chance to use this sprite: the higher the number in comparison to other sprites in the list, the more likely it is to be used; same as artifacts work. 1 by default.

Definition at line 170 of file effects.h.

uint32_t effect_sprite_def::delay

How long to delay until another movement, in ticks. Default is 0.

Definition at line 173 of file effects.h.

int effect_sprite_def::id

ID of in-game sprite to use.

Definition at line 151 of file effects.h.

uint8_t effect_sprite_def::kill_side_left

Whether to kill sprites that go too far to the left (off screen), 1 by default.

Definition at line 234 of file effects.h.

uint8_t effect_sprite_def::kill_side_right

Whether to kill sprites that go too far to the right (off screen), 0 by default.

Definition at line 240 of file effects.h.

char* effect_sprite_def::name

Name of the in-game sprite to use.

Definition at line 154 of file effects.h.

struct effect_sprite_def* effect_sprite_def::next

Next sprite definition in a linked list.

Definition at line 148 of file effects.h.

uint8_t effect_sprite_def::reverse

Whether to go from bottom to top, instead of top to bottom, 0 by default.

Definition at line 204 of file effects.h.

char effect_sprite_def::sound_file[MAX_BUF]

Sound effect to play each time this sprite is created. By default, no sound is played.

Definition at line 260 of file effects.h.

uint8_t effect_sprite_def::sound_volume

Volume of the sound effect to play. Default is 100.

Definition at line 263 of file effects.h.

uint32_t effect_sprite_def::ttl

Time to live (in ticks).

Definition at line 254 of file effects.h.

uint8_t effect_sprite_def::warp_sides

Warp sprites going too far to the sides (off screen), 1 by default.

Definition at line 251 of file effects.h.

double effect_sprite_def::weight

Weight of the sprite: affects how fast it falls down, and gets blown away by wind, default is 1.0.

Definition at line 160 of file effects.h.

double effect_sprite_def::weight_mod

Weight modification, default is 2.0.

Definition at line 163 of file effects.h.

double effect_sprite_def::wiggle

How much to wiggle when falling down, 0.0 to fall straight down. Default 1.0.

Definition at line 182 of file effects.h.

uint8_t effect_sprite_def::wind

Non-zero value to enable wind simulation. Default is 1.

Definition at line 176 of file effects.h.

double effect_sprite_def::wind_mod

How much to affect randomization part of wind blowing simulation (0.0 to disable the randomization). Default is 1.0.

Definition at line 188 of file effects.h.

int effect_sprite_def::x

X position of the sprite, -1 for random (default).

Definition at line 191 of file effects.h.

uint8_t effect_sprite_def::x_check_mod

Whether to affect side-checking of sprites with the sprite's width, 1 by default.

Definition at line 222 of file effects.h.

double effect_sprite_def::x_mod

X calculation modification.

Definition at line 213 of file effects.h.

int effect_sprite_def::xpos

X position modifier, 0 by default.

Definition at line 197 of file effects.h.

int effect_sprite_def::y

Y position of the sprite, -1 for random (default).

Definition at line 194 of file effects.h.

uint8_t effect_sprite_def::y_check_mod

Whether to affect side-checking of sprites with the sprite's height, 1 by default.

Definition at line 228 of file effects.h.

double effect_sprite_def::y_mod

Y calculation modification.

Definition at line 216 of file effects.h.

double effect_sprite_def::y_rndm

Initial Y starting position; will be randomized between 0-value. Default is 60.0.

Definition at line 210 of file effects.h.

int effect_sprite_def::ypos

Y position modifier, 0 by default.

Definition at line 200 of file effects.h.

uint16_t effect_sprite_def::zoom

How much to zoom this sprite, 0 by default (no zoom), 100 = same as current sprite, 200 = twice as big.

Definition at line 246 of file effects.h.


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