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.41 by root, Mon Oct 1 01:43:39 2012 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.
… …
202 226
203=head3 inscribe_note (book pl message skill -- ) 227=head3 inscribe_note (book pl message skill -- )
204 228
205Used whenever a book gets inscribed with a message. 229Used whenever a book gets inscribed with a message.
206 230
231=head3 infect (victim disease_type disease -- )
232
233Invoked whenever an object is diseased. The disease object is already
234inserted in object (the template disease object is C<disease_type>),
235but no messages have been generated. If overriden, no messages will be
236generated.
237
207=head3 trigger (object who -- ) 238=head3 trigger (object who -- )
208 239
209Invoked whenever a lever-like B<object> has been activated/triggered in some 240Invoked whenever a lever-like B<object> has been activated/triggered in some
210(manual) way. 241(manual) way.
211 242
… …
275Invoked when the given player is being kicked, before the kick is 306Invoked when the given player is being kicked, before the kick is
276executed. 307executed.
277 308
278=head3 load (player -- ) 309=head3 load (player -- )
279 310
280Invoked whenever a player has been loaded from disk, but before 311Invoked whenever after a player has been loaded from disk, but before
281actual login. 312actual activation/login.
282 313
283=head3 save (player -- ) 314=head3 save (player -- )
284 315
285Invoked just before a player gets serialised. 316Invoked just before a player gets serialised.
286 317
… …
316 347
317Invoked when a player entered a new region. Cannot be overriden. 348Invoked when a player entered a new region. Cannot be overriden.
318 349
319=head3 command (player command args -- time) 350=head3 command (player command args -- time)
320 351
321Execute a user command send by the client. Programmable plug-ins usually 352Execute a user command sent by the client - this is invoked for I<all>
322handle this event internally. 353command,s so should not normally be hooked.
354
355=head3 unknown_command (player command args -- time)
356
357Execute a user command sent by the client that isn't known to the
358server. Programmable plug-ins usually handle this event internally.
323 359
324=head3 extcmd (player string) 360=head3 extcmd (player string)
325 361
326Invoked whenever a client issues the C<extcmd> protocol command. 362Invoked whenever a client issues the C<extcmd> protocol command.
327Programmable plug-ins usually handle this event internally. 363Programmable plug-ins usually handle this event internally.
… …
355=head3 shout (player message --) 391=head3 shout (player message --)
356 392
357Invoked whenever the player uses the B<say>, B<chat> or B<shout> command, 393Invoked whenever the player uses the B<say>, B<chat> or B<shout> command,
358before it gets processed. 394before it gets processed.
359 395
396=head3 build (player builder map x y checkok --)
397
398Players tries to build using C<builder> at (map+x+y). Is invoked after
399the usual map sanity checks, so the coordinates are valid. The boolean
400C<checkok> is true only if the build code thinks it is "ok" to build at
401that space, and normally you should only build when it is true.
402
360 403
361=head2 MAP EVENTS 404=head2 MAP EVENTS
362 405
363These events are generally dependent on a map and thus all have a map 406These events are generally dependent on a map and thus all have a map
364as first argument. 407as first argument.
… …
407handled asynchronously as soon as the command reaches the server, even when 450handled asynchronously as soon as the command reaches the server, even when
408the player hasn't logged in yet (meaning there is no player yet). 451the player hasn't logged in yet (meaning there is no player yet).
409 452
410=head3 connect (client -- ) 453=head3 connect (client -- )
411 454
412Called as soon as a new connection to the server is established. Should 455Called as soon as a new connection to the server is established and the
413not be overriden. 456socket has been configured.
457
458=head3 version (client string -- )
459
460Called as soon as the version command from the client is received
461(normally the very first command sent).
414 462
415=head3 setup (client string -- ) 463=head3 setup (client string -- )
416 464
417Client sent the setup command to negotiate parameters. Handling is 465Client sent the setup command to negotiate parameters. Handling is
418mandatory and done by F<login.ext>. 466mandatory and done by F<login.ext>.
… …
431 479
432Like C<extcmd>, but can be called before a player has logged in. 480Like C<extcmd>, but can be called before a player has logged in.
433 481
434Programmable plug-ins usually handle this event internally. 482Programmable plug-ins usually handle this event internally.
435 483
484=head3 client_destroy (client -- )
485
486Invoked when the client gets destroyed.
487
488

Diff Legend

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