cfanim.h File Reference

#include <plugin.h>
#include <plugin_common.h>
#include <cfanim_proto.h>

Include dependency graph for cfanim.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	CFanimation_struct
	One full animation. More...
struct	CFanimationHook
	Available animation move. More...
struct	CFmovement_struct
	One move in an animation. More...
Defines
#define	PLUGIN_NAME   "Animator"
#define	PLUGIN_VERSION   "CFAnim Plugin 2.0"
Typedefs
typedef enum anim_move_result	anim_move_result
	Result of one animation move.
typedef struct CFanimation_struct	CFanimation
	One full animation.
typedef long int(*	CFAnimInitFunc )(const char *name, char *parameters, struct CFmovement_struct *)
typedef anim_move_result(*	CFAnimRunFunc )(struct CFanimation_struct *animation, long int id, void *parameters)
typedef struct CFmovement_struct	CFmovement
	One move in an animation.
Enumerations
enum	anim_move_result { mr_finished, mr_again }
	Result of one animation move. More...
enum	time_enum { time_second, time_tick }
	Time units the animation can use. More...
Variables
CFanimationHook	animationbox []
	Available animation commands.
int	animationcount

---

Define Documentation

#define PLUGIN_NAME   "Animator"

Definition at line 32 of file cfanim.h.

Referenced by add_npc_to_random_map(), add_npcs_to_map(), check_tables(), do_kills(), do_sql(), eventListener(), get_newspaper_content(), get_npc(), getPluginProperty(), postInitPlugin(), registerGEvent(), and unregisterGEvent().

#define PLUGIN_VERSION   "CFAnim Plugin 2.0"

Definition at line 33 of file cfanim.h.

Referenced by closePlugin(), getPluginProperty(), initPlugin(), and postInitPlugin().

---

Typedef Documentation

typedef enum anim_move_result anim_move_result

Result of one animation move.

typedef struct CFanimation_struct CFanimation

One full animation.

typedef long int(* CFAnimInitFunc)(const char *name, char *parameters, struct CFmovement_struct *)

Definition at line 58 of file cfanim.h.

typedef anim_move_result(* CFAnimRunFunc)(struct CFanimation_struct *animation, long int id, void *parameters)

Definition at line 56 of file cfanim.h.

typedef struct CFmovement_struct CFmovement

One move in an animation.

---

Enumeration Type Documentation

enum anim_move_result

Result of one animation move.

Enumerator:

mr_finished	Move completed.
mr_again	Move should continue next time.

Definition at line 48 of file cfanim.h.

enum time_enum

Time units the animation can use.

Todo:

add owner's speed unit

Enumerator:

time_second	One second.
time_tick	One server tick.

Definition at line 42 of file cfanim.h.

---

Variable Documentation

CFanimationHook animationbox[]

Available animation commands.

Definition at line 461 of file cfanim.c.

int animationcount

Definition at line 510 of file cfanim.c.

Referenced by get_command(), and prepare_commands().