--- deliantra/server/pod/events.pod 2009/10/21 00:44:39 1.32 +++ deliantra/server/pod/events.pod 2010/04/08 17:36:54 1.38 @@ -1,3 +1,27 @@ +=begin comment + + This file is part of Deliantra, the Roguelike Realtime MMORPG. + + Copyright (©) 2005,2006,2007,2008,2009 Marc Alexander Lehmann / Robin Redeker / the Deliantra team + + Deliantra is free software: you can redistribute it and/or modify it under + the terms of the Affero GNU General Public License as published by the + Free Software Foundation, either version 3 of the License, or (at your + option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the Affero GNU General Public License + and the GNU General Public License along with this program. If not, see + . + + The authors can be reached via e-mail to + +=end comment + =head1 DELIANTRA PLUG-IN EVENTS This document briefly describes each plug-in event. It is also used to @@ -277,8 +301,8 @@ =head3 load (player -- ) -Invoked whenever a player has been loaded from disk, but before -actual login. +Invoked whenever after a player has been loaded from disk, but before +actual activation/login. =head3 save (player -- ) @@ -318,8 +342,13 @@ =head3 command (player command args -- time) -Execute a user command send by the client. Programmable plug-ins usually -handle this event internally. +Execute a user command sent by the client - this is invoked for I +command,s so should not normally be hooked. + +=head3 unknown_command (player command args -- time) + +Execute a user command sent by the client that isn't known to the +server. Programmable plug-ins usually handle this event internally. =head3 extcmd (player string) @@ -357,6 +386,11 @@ Invoked whenever the player uses the B, B or B command, before it gets processed. +=head3 build (player builder map x y --) + +Players tries to build using C at (map+x+y). Is invoked after the +usual sanity checks, so the coordinates are valid. + =head2 MAP EVENTS @@ -412,6 +446,11 @@ Called as soon as a new connection to the server is established. Should not be overriden. +=head3 version (client string -- ) + +Called as soon as the version command from the client is received +(normally the very first command sent). + =head3 setup (client string -- ) Client sent the setup command to negotiate parameters. Handling is @@ -433,3 +472,8 @@ Programmable plug-ins usually handle this event internally. +=head3 client_destroy (client -- ) + +Invoked when the client gets destroyed. + +