1.1 --- a/plugins/include/events.inc Sat Jan 19 16:47:31 2008 +0000
1.2 +++ b/plugins/include/events.inc Sat Jan 19 20:58:10 2008 +0000
1.3 @@ -108,6 +108,9 @@
1.4 /**
1.5 * Creates a game event to be fired later.
1.6 *
1.7 + * The Handle should not be closed via CloseHandle(). It must be closed via
1.8 + * FireEvent() or CancelCreatedEvent().
1.9 + *
1.10 * @param name Name of event.
1.11 * @param force If set to true, this forces the event to be created even if it's not being hooked.
1.12 * Note that this will not force it if the event doesn't exist at all.
1.13 @@ -119,6 +122,8 @@
1.14 /**
1.15 * Fires a game event.
1.16 *
1.17 + * This function closes the event Handle after completing.
1.18 + *
1.19 * @param event Handle to the event.
1.20 * @param dontBroadcast Optional boolean that determines if event should be broadcast to clients.
1.21 * @noreturn
1.22 @@ -169,6 +174,11 @@
1.23 /**
1.24 * Sets the integer value of a game event's key.
1.25 *
1.26 + * Integer value refers to anything that can be reduced to an integer.
1.27 + * The various size specifiers, such as "byte" and "short" are still
1.28 + * integers, and only refer to how much data will actually be sent
1.29 + * over the network (if applicable).
1.30 + *
1.31 * @param event Handle to the event.
1.32 * @param key Name of event key.
1.33 * @param value New integer value.