[ViewVC] Diff of: cvs/deliantra/server/pod/events.pod

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.35 by root, Fri Mar 19 22:16:27 2010 UTC vs.
Revision 1.41 by root, Mon Oct 1 01:43:39 2012 UTC

 =head3 inscribe_note (book pl message skill -- )
 Used whenever a book gets inscribed with a message.
+=head3 infect (victim disease_type disease -- )
+Invoked whenever an object is diseased. The disease object is already
+inserted in object (the template disease object is C<disease_type>),
+but no messages have been generated. If overriden, no messages will be
+generated.
 =head3 trigger (object who -- )
 Invoked whenever a lever-like B<object> has been activated/triggered in some
 (manual) way.
 Invoked when the given player is being kicked, before the kick is
 executed.
 =head3 load (player -- )
-Invoked whenever a player has been loaded from disk, but before
+Invoked whenever after a player has been loaded from disk, but before
-actual login.
+actual activation/login.
 =head3 save (player -- )
 Invoked just before a player gets serialised.
 Invoked when a player entered a new region. Cannot be overriden.
 =head3 command (player command args -- time)
-Execute a user command send by the client. Programmable plug-ins usually
+Execute a user command sent by the client - this is invoked for I<all>
-handle this event internally.
+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)
 Invoked whenever a client issues the C<extcmd> protocol command.
 Programmable plug-ins usually handle this event internally.
 =head3 shout (player message --)
 Invoked whenever the player uses the B<say>, B<chat> or B<shout> command,
 before it gets processed.
-=head3 build (player builder map x y --)
+=head3 build (player builder map x y checkok --)
-Players tries to build using C<builder> at (map+x+y). Is invoked after the
+Players tries to build using C<builder> at (map+x+y). Is invoked after
-usual sanity checks, so the coordinates are valid.
+the usual map sanity checks, so the coordinates are valid. The boolean
+C<checkok> is true only if the build code thinks it is "ok" to build at
+that space, and normally you should only build when it is true.
 =head2 MAP EVENTS
 These events are generally dependent on a map and thus all have a map
 handled asynchronously as soon as the command reaches the server, even when
 the player hasn't logged in yet (meaning there is no player yet).
 =head3 connect (client -- )
-Called as soon as a new connection to the server is established. Should
+Called as soon as a new connection to the server is established and the
-not be overriden.
+socket has been configured.
+=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
 mandatory and done by F<login.ext>.
 Like C<extcmd>, but can be called before a player has logged in.
 Programmable plug-ins usually handle this event internally.
+=head3 client_destroy (client -- )
+Invoked when the client gets destroyed.

Diff Legend

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

Comparing deliantra/server/pod/events.pod (file contents): Revision 1.35 by root, Fri Mar 19 22:16:27 2010 UTC vs. Revision 1.41 by root, Mon Oct 1 01:43:39 2012 UTC

Diff Legend

Comparing deliantra/server/pod/events.pod (file contents):
Revision 1.35 by root, Fri Mar 19 22:16:27 2010 UTC vs.
Revision 1.41 by root, Mon Oct 1 01:43:39 2012 UTC