ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/plugin.h
Revision: 1.11
Committed: Fri Aug 25 13:24:50 2006 UTC (17 years, 9 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.10: +1 -16 lines
Log Message:
Implemented a rough outline of the new event system and made use of it
for a number of events. The corresponding plugin-events have been disabled.

File Contents

# User Rev Content
1 root 1.1 /*****************************************************************************/
2     /* Crossfire plugin support - (C) 2001 by Yann Chachkoff. */
3     /* This code is placed under the GPL. */
4     /*****************************************************************************/
5    
6     /*****************************************************************************/
7     /* Headers needed. */
8     /*****************************************************************************/
9    
10     #ifndef PLUGIN_H_
11     #define PLUGIN_H_
12    
13     /*****************************************************************************/
14     /* This one does not exist under Win32. */
15     /*****************************************************************************/
16     #ifndef WIN32
17     #include <dlfcn.h>
18     #endif
19    
20     #undef MODULEAPI
21     #ifdef WIN32
22     #ifdef PYTHON_PLUGIN_EXPORTS
23     #define MODULEAPI __declspec(dllexport)
24     #else
25     #define MODULEAPI __declspec(dllimport)
26     #endif
27     #else
28     #define MODULEAPI
29     #endif
30    
31     #include <global.h>
32     #include <object.h>
33    
34     #ifdef HAVE_TIME_H
35     #include <time.h>
36     #endif
37     #include <../random_maps/random_map.h>
38     #include <../random_maps/rproto.h>
39    
40    
41     /*****************************************************************************/
42     /* This one does not exist under Win32. */
43     /*****************************************************************************/
44     #ifndef WIN32
45     #include <dirent.h>
46     #endif
47    
48     /*****************************************************************************/
49     /* Event ID codes. I sorted them to present local events first, but it is */
50     /* just a 'cosmetic' thing. */
51     /*****************************************************************************/
52     /*****************************************************************************/
53     /* Local events. Those are always linked to a specific object. */
54     /*****************************************************************************/
55 root 1.2 // how about making this an enum
56 root 1.1 #define EVENT_NONE 0 /* No event. This exists only to reserve the "0". */
57     #define EVENT_APPLY 1 /* Object applied-unapplied. */
58     #define EVENT_ATTACK 2 /* Monster attacked or Scripted Weapon used. */
59 root 1.11 #define EVENT_DEATH 3
60 root 1.1 #define EVENT_DROP 4 /* Object dropped on the floor. */
61     #define EVENT_PICKUP 5 /* Object picked up. */
62     #define EVENT_SAY 6 /* Someone speaks. */
63     #define EVENT_STOP 7 /* Thrown object stopped. */
64     #define EVENT_TIME 8 /* Triggered each time the object can react/move. */
65     #define EVENT_THROW 9 /* Object is thrown. */
66     #define EVENT_TRIGGER 10 /* Button pushed, lever pulled, etc. */
67     #define EVENT_CLOSE 11 /* Container closed. */
68     #define EVENT_TIMER 12 /* Timer connected triggered it. */
69 root 1.2 #define EVENT_MOVE 28 /* Monster move */
70 root 1.1 /*****************************************************************************/
71     /* Global events. Those are never linked to a specific object. */
72     /*****************************************************************************/
73     #define EVENT_CLOCK 14 /* Global time event. */
74     #define EVENT_CRASH 15 /* Triggered when the server crashes. Not recursive*/
75     #define EVENT_GKILL 17 /* Triggered when anything got killed by anyone. */
76     #define EVENT_SHOUT 24 /* A player 'shout' something. */
77 root 1.2 #define EVENT_TELL 25 /* A player 'tell' something. */
78     #define EVENT_MUZZLE 26 /* A player was Muzzled (no_shout set). */
79 root 1.1 #define EVENT_KICK 27 /* A player was Kicked by a DM */
80 elmex 1.9 #define EVENT_PLAYER_USE_SKILL 36 /* player was just trying to use a skill */
81     #define EVENT_MONSTER_USE_SKILL 37 /* monster was just trying to use a skill*/
82 elmex 1.8 #define EVENT_FIND_UNARMED_SKILL 38 /* lets a plugin find the unarmed skill */
83 elmex 1.9 #define EVENT_EXTCMD 39 /* Low-Level socket command */
84     #define EVENT_CAST_SPELL 40 /* Something successfully casted a spell */
85 elmex 1.10 #define EVENT_DROP_ON 41 /* Something was dropped on this (floor) */
86 root 1.2 /* should add FREE_MAP, FREE_PLAYER */
87 root 1.1
88 elmex 1.10 #define NR_EVENTS 42
89 root 1.1
90     #include <stdarg.h>
91    
92     #define CFAPI_NONE 0
93     #define CFAPI_INT 1
94     #define CFAPI_LONG 2
95     #define CFAPI_CHAR 3
96     #define CFAPI_STRING 4
97     #define CFAPI_POBJECT 5
98     #define CFAPI_PMAP 6
99     #define CFAPI_FLOAT 7
100     #define CFAPI_DOUBLE 8
101     #define CFAPI_PARCH 9
102     #define CFAPI_FUNC 10
103     #define CFAPI_PPLAYER 11
104     #define CFAPI_PPARTY 12
105     #define CFAPI_PREGION 13
106 elmex 1.3 #define CFAPI_INT16 14
107 root 1.1
108     typedef void* (*f_plug_api) (int* type, ...);
109     typedef int (*f_plug_postinit) (void);
110     typedef int (*f_plug_init)(const char* iversion, f_plug_api gethooksptr);
111    
112     #ifndef WIN32
113     #define LIBPTRTYPE void*
114     #else
115     #define LIBPTRTYPE HMODULE
116     #endif
117    
118     typedef struct _crossfire_plugin
119     {
120     f_plug_api eventfunc; /* Event Handler function */
121     f_plug_api propfunc; /* Plugin getProperty function */
122     f_plug_postinit closefunc; /* Plugin Termination function */
123     LIBPTRTYPE libptr; /* Pointer to the plugin library */
124     char id[MAX_BUF]; /* Plugin identification string */
125     char fullname[MAX_BUF]; /* Plugin full name */
126     f_plug_api gevent[NR_EVENTS]; /* Global events registered */
127     struct _crossfire_plugin *next;
128     struct _crossfire_plugin *prev;
129     } crossfire_plugin;
130    
131     extern int plugin_number;
132     extern crossfire_plugin* plugins_list;
133    
134     #ifdef WIN32
135    
136     #define plugins_dlopen(fname) LoadLibrary(fname)
137     #define plugins_dlclose(lib) FreeLibrary(lib)
138     #define plugins_dlsym(lib,name) GetProcAddress(lib,name)
139    
140     #else /*WIN32 */
141    
142     #define plugins_dlopen(fname) dlopen(fname,RTLD_NOW|RTLD_GLOBAL)
143     #define plugins_dlclose(lib) dlclose(lib)
144     #define plugins_dlsym(lib,name) dlsym(lib,name)
145     #define plugins_dlerror() dlerror()
146     #endif /* WIN32 */
147    
148    
149     /* OBJECT-RELATED HOOKS */
150    
151     #define CFAPI_OBJECT_PROP_OB_ABOVE 1
152     #define CFAPI_OBJECT_PROP_OB_BELOW 2
153     #define CFAPI_OBJECT_PROP_NEXT_ACTIVE_OB 3
154     #define CFAPI_OBJECT_PROP_PREV_ACTIVE_OB 4
155     #define CFAPI_OBJECT_PROP_INVENTORY 5
156     #define CFAPI_OBJECT_PROP_ENVIRONMENT 6
157     #define CFAPI_OBJECT_PROP_HEAD 7
158     #define CFAPI_OBJECT_PROP_CONTAINER 8
159     #define CFAPI_OBJECT_PROP_MAP 9
160     #define CFAPI_OBJECT_PROP_COUNT 10
161     #define CFAPI_OBJECT_PROP_REFCOUNT 11
162     #define CFAPI_OBJECT_PROP_NAME 12
163     #define CFAPI_OBJECT_PROP_NAME_PLURAL 13
164     #define CFAPI_OBJECT_PROP_TITLE 14
165     #define CFAPI_OBJECT_PROP_RACE 15
166     #define CFAPI_OBJECT_PROP_SLAYING 16
167     #define CFAPI_OBJECT_PROP_SKILL 17
168     #define CFAPI_OBJECT_PROP_MESSAGE 18
169     #define CFAPI_OBJECT_PROP_LORE 19
170     #define CFAPI_OBJECT_PROP_X 20
171     #define CFAPI_OBJECT_PROP_Y 21
172     #define CFAPI_OBJECT_PROP_SPEED 22
173     #define CFAPI_OBJECT_PROP_SPEED_LEFT 23
174     #define CFAPI_OBJECT_PROP_NROF 24
175     #define CFAPI_OBJECT_PROP_DIRECTION 25
176     #define CFAPI_OBJECT_PROP_FACING 26
177     #define CFAPI_OBJECT_PROP_TYPE 27
178     #define CFAPI_OBJECT_PROP_SUBTYPE 28
179     #define CFAPI_OBJECT_PROP_CLIENT_TYPE 29
180     #define CFAPI_OBJECT_PROP_RESIST 30
181     #define CFAPI_OBJECT_PROP_ATTACK_TYPE 31
182     #define CFAPI_OBJECT_PROP_PATH_ATTUNED 32
183     #define CFAPI_OBJECT_PROP_PATH_REPELLED 33
184     #define CFAPI_OBJECT_PROP_PATH_DENIED 34
185     #define CFAPI_OBJECT_PROP_MATERIAL 35
186     #define CFAPI_OBJECT_PROP_MATERIAL_NAME 36
187     #define CFAPI_OBJECT_PROP_MAGIC 37
188     #define CFAPI_OBJECT_PROP_VALUE 38
189     #define CFAPI_OBJECT_PROP_LEVEL 39
190     #define CFAPI_OBJECT_PROP_LAST_HEAL 40
191     #define CFAPI_OBJECT_PROP_LAST_SP 41
192     #define CFAPI_OBJECT_PROP_LAST_GRACE 42
193     #define CFAPI_OBJECT_PROP_LAST_EAT 43
194     #define CFAPI_OBJECT_PROP_INVISIBLE_TIME 44
195     #define CFAPI_OBJECT_PROP_PICK_UP 45
196     #define CFAPI_OBJECT_PROP_ITEM_POWER 46
197     #define CFAPI_OBJECT_PROP_GEN_SP_ARMOUR 47
198     #define CFAPI_OBJECT_PROP_WEIGHT 48
199     #define CFAPI_OBJECT_PROP_WEIGHT_LIMIT 49
200     #define CFAPI_OBJECT_PROP_CARRYING 50
201     #define CFAPI_OBJECT_PROP_GLOW_RADIUS 51
202     #define CFAPI_OBJECT_PROP_PERM_EXP 52
203     #define CFAPI_OBJECT_PROP_CURRENT_WEAPON 53
204     #define CFAPI_OBJECT_PROP_ENEMY 54
205     #define CFAPI_OBJECT_PROP_ATTACKED_BY 55
206     #define CFAPI_OBJECT_PROP_RUN_AWAY 56
207     #define CFAPI_OBJECT_PROP_CHOSEN_SKILL 57
208     #define CFAPI_OBJECT_PROP_HIDDEN 58
209     #define CFAPI_OBJECT_PROP_MOVE_STATUS 59
210     #define CFAPI_OBJECT_PROP_MOVE_TYPE 60
211     #define CFAPI_OBJECT_PROP_SPELL_ITEM 61
212     #define CFAPI_OBJECT_PROP_EXP_MULTIPLIER 62
213     #define CFAPI_OBJECT_PROP_ARCHETYPE 63
214     #define CFAPI_OBJECT_PROP_OTHER_ARCH 64
215     #define CFAPI_OBJECT_PROP_CUSTOM_NAME 65
216     #define CFAPI_OBJECT_PROP_ANIM_SPEED 66
217     #define CFAPI_OBJECT_PROP_FRIENDLY 67
218     #define CFAPI_OBJECT_PROP_SHORT_NAME 68
219     #define CFAPI_OBJECT_PROP_BASE_NAME 69
220     #define CFAPI_OBJECT_PROP_MAGICAL 70
221     #define CFAPI_OBJECT_PROP_LUCK 71
222     #define CFAPI_OBJECT_PROP_EXP 72
223     #define CFAPI_OBJECT_PROP_OWNER 73
224     #define CFAPI_OBJECT_PROP_PRESENT 74
225     #define CFAPI_OBJECT_PROP_CHEATER 75
226     #define CFAPI_OBJECT_PROP_MERGEABLE 76
227     #define CFAPI_OBJECT_PROP_PICKABLE 77
228     #define CFAPI_OBJECT_PROP_FLAGS 78
229     #define CFAPI_OBJECT_PROP_STR 79
230     #define CFAPI_OBJECT_PROP_DEX 80
231     #define CFAPI_OBJECT_PROP_CON 81
232     #define CFAPI_OBJECT_PROP_WIS 82
233     #define CFAPI_OBJECT_PROP_INT 83
234     #define CFAPI_OBJECT_PROP_POW 84
235     #define CFAPI_OBJECT_PROP_CHA 85
236     #define CFAPI_OBJECT_PROP_WC 86
237     #define CFAPI_OBJECT_PROP_AC 87
238     #define CFAPI_OBJECT_PROP_HP 88
239     #define CFAPI_OBJECT_PROP_SP 89
240     #define CFAPI_OBJECT_PROP_GP 90
241     #define CFAPI_OBJECT_PROP_FP 91
242     #define CFAPI_OBJECT_PROP_MAXHP 92
243     #define CFAPI_OBJECT_PROP_MAXSP 93
244     #define CFAPI_OBJECT_PROP_MAXGP 94
245     #define CFAPI_OBJECT_PROP_DAM 95
246     #define CFAPI_OBJECT_PROP_GOD 96
247     #define CFAPI_OBJECT_PROP_ARCH_NAME 97
248     #define CFAPI_OBJECT_PROP_INVISIBLE 98
249     #define CFAPI_OBJECT_PROP_FACE 99
250     #define CFAPI_OBJECT_ANIMATION 100
251     #define CFAPI_PLAYER_PROP_IP 150
252     #define CFAPI_PLAYER_PROP_MARKED_ITEM 151
253     #define CFAPI_PLAYER_PROP_PARTY 152
254    
255     #define CFAPI_MAP_PROP_FLAGS 0
256     #define CFAPI_MAP_PROP_DIFFICULTY 1
257     #define CFAPI_MAP_PROP_PATH 2
258     #define CFAPI_MAP_PROP_TMPNAME 3
259     #define CFAPI_MAP_PROP_NAME 4
260     #define CFAPI_MAP_PROP_RESET_TIME 5
261     #define CFAPI_MAP_PROP_RESET_TIMEOUT 6
262     #define CFAPI_MAP_PROP_PLAYERS 7
263     #define CFAPI_MAP_PROP_LIGHT 8
264     #define CFAPI_MAP_PROP_DARKNESS 9
265     #define CFAPI_MAP_PROP_WIDTH 10
266     #define CFAPI_MAP_PROP_HEIGHT 11
267     #define CFAPI_MAP_PROP_ENTER_X 12
268     #define CFAPI_MAP_PROP_ENTER_Y 13
269     #define CFAPI_MAP_PROP_TEMPERATURE 14
270     #define CFAPI_MAP_PROP_PRESSURE 15
271     #define CFAPI_MAP_PROP_HUMIDITY 16
272     #define CFAPI_MAP_PROP_WINDSPEED 17
273     #define CFAPI_MAP_PROP_WINDDIR 18
274     #define CFAPI_MAP_PROP_SKY 19
275     #define CFAPI_MAP_PROP_WPARTX 20
276     #define CFAPI_MAP_PROP_WPARTY 21
277     #define CFAPI_MAP_PROP_MESSAGE 22
278     #define CFAPI_MAP_PROP_NEXT 23
279     #define CFAPI_MAP_PROP_REGION 24
280    
281     #define CFAPI_ARCH_PROP_NAME 0
282     #define CFAPI_ARCH_PROP_NEXT 1
283     #define CFAPI_ARCH_PROP_HEAD 2
284     #define CFAPI_ARCH_PROP_MORE 3
285     #define CFAPI_ARCH_PROP_CLONE 4
286    
287     #define CFAPI_PARTY_PROP_NAME 0
288     #define CFAPI_PARTY_PROP_NEXT 1
289     #define CFAPI_PARTY_PROP_PASSWORD 2
290     #define CFAPI_PARTY_PROP_PLAYER 3
291    
292     #define CFAPI_REGION_PROP_NAME 0
293     #define CFAPI_REGION_PROP_NEXT 1
294     #define CFAPI_REGION_PROP_PARENT 2
295     #define CFAPI_REGION_PROP_LONGNAME 3
296     #define CFAPI_REGION_PROP_MESSAGE 4
297    
298     /*****************************************************************************/
299     /* Exportable functions. Any plugin should define all those. */
300     /* initPlugin is called when the plugin initialization process starts.*/
301     /* endPlugin is called before the plugin gets unloaded from memory. */
302     /* getPluginProperty is currently unused. */
303     /* registerHook is used to transmit hook pointers from server to plugin.*/
304     /* triggerEvent is called whenever an event occurs. */
305     /*****************************************************************************/
306     /*extern MODULEAPI CFParm* initPlugin(CFParm* PParm);
307     extern MODULEAPI CFParm* endPlugin(CFParm* PParm);
308     extern MODULEAPI CFParm* getPluginProperty(CFParm* PParm);
309     extern MODULEAPI CFParm* registerHook(CFParm* PParm);
310     extern MODULEAPI CFParm* triggerEvent(CFParm* PParm);
311     */
312    
313     typedef struct _hook_entry
314     {
315     f_plug_api func;
316     int fid;
317     char fname[256];
318     } hook_entry;
319    
320     #endif /*PLUGIN_H_*/