ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/pod/events.pod
(Generate patch)

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.32 by root, Wed Oct 21 00:44:39 2009 UTC vs.
Revision 1.38 by root, Thu Apr 8 17:36:54 2010 UTC

1=begin comment
2
3 This file is part of Deliantra, the Roguelike Realtime MMORPG.
4
5 Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
6
7 Deliantra is free software: you can redistribute it and/or modify it under
8 the terms of the Affero GNU General Public License as published by the
9 Free Software Foundation, either version 3 of the License, or (at your
10 option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the Affero GNU General Public License
18 and the GNU General Public License along with this program. If not, see
19 <http://www.gnu.org/licenses/>.
20
21 The authors can be reached via e-mail to <support@deliantra.net>
22
23=end comment
24
1=head1 DELIANTRA PLUG-IN EVENTS 25=head1 DELIANTRA PLUG-IN EVENTS
2 26
3This document briefly describes each plug-in event. It is also used to 27This document briefly describes each plug-in event. It is also used to
4generate the event-list itself, so is always complete. Be careful wehn 28generate the event-list itself, so is always complete. Be careful wehn
5changing it, though. 29changing it, though.
… …
275Invoked when the given player is being kicked, before the kick is 299Invoked when the given player is being kicked, before the kick is
276executed. 300executed.
277 301
278=head3 load (player -- ) 302=head3 load (player -- )
279 303
280Invoked whenever a player has been loaded from disk, but before 304Invoked whenever after a player has been loaded from disk, but before
281actual login. 305actual activation/login.
282 306
283=head3 save (player -- ) 307=head3 save (player -- )
284 308
285Invoked just before a player gets serialised. 309Invoked just before a player gets serialised.
286 310
… …
316 340
317Invoked when a player entered a new region. Cannot be overriden. 341Invoked when a player entered a new region. Cannot be overriden.
318 342
319=head3 command (player command args -- time) 343=head3 command (player command args -- time)
320 344
321Execute a user command send by the client. Programmable plug-ins usually 345Execute a user command sent by the client - this is invoked for I<all>
322handle this event internally. 346command,s so should not normally be hooked.
347
348=head3 unknown_command (player command args -- time)
349
350Execute a user command sent by the client that isn't known to the
351server. Programmable plug-ins usually handle this event internally.
323 352
324=head3 extcmd (player string) 353=head3 extcmd (player string)
325 354
326Invoked whenever a client issues the C<extcmd> protocol command. 355Invoked whenever a client issues the C<extcmd> protocol command.
327Programmable plug-ins usually handle this event internally. 356Programmable plug-ins usually handle this event internally.
… …
355=head3 shout (player message --) 384=head3 shout (player message --)
356 385
357Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, 386Invoked whenever the player uses the B<say>, B<chat> or B<shout> command,
358before it gets processed. 387before it gets processed.
359 388
389=head3 build (player builder map x y --)
390
391Players tries to build using C<builder> at (map+x+y). Is invoked after the
392usual sanity checks, so the coordinates are valid.
393
360 394
361=head2 MAP EVENTS 395=head2 MAP EVENTS
362 396
363These events are generally dependent on a map and thus all have a map 397These events are generally dependent on a map and thus all have a map
364as first argument. 398as first argument.
… …
410=head3 connect (client -- ) 444=head3 connect (client -- )
411 445
412Called as soon as a new connection to the server is established. Should 446Called as soon as a new connection to the server is established. Should
413not be overriden. 447not be overriden.
414 448
449=head3 version (client string -- )
450
451Called as soon as the version command from the client is received
452(normally the very first command sent).
453
415=head3 setup (client string -- ) 454=head3 setup (client string -- )
416 455
417Client sent the setup command to negotiate parameters. Handling is 456Client sent the setup command to negotiate parameters. Handling is
418mandatory and done by F<login.ext>. 457mandatory and done by F<login.ext>.
419 458
… …
431 470
432Like C<extcmd>, but can be called before a player has logged in. 471Like C<extcmd>, but can be called before a player has logged in.
433 472
434Programmable plug-ins usually handle this event internally. 473Programmable plug-ins usually handle this event internally.
435 474
475=head3 client_destroy (client -- )
476
477Invoked when the client gets destroyed.
478
479

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines