UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added some more doc to events

Browse Source 
--HG--
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%401857
This commit is contained in:
David Anderson 2008-01-19 20:58:10 +00:00
parent 97062c4de8
commit f939f47218
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/include/events.inc
View File

@ -108,6 +108,9 @@ native UnhookEvent(const String:name[], EventHook:callback, EventHookMode:mode=E
/** /**
* Creates a game event to be fired later. * Creates a game event to be fired later.
* *
* The Handle should not be closed via CloseHandle(). It must be closed via
* FireEvent() or CancelCreatedEvent().
*
* @param name Name of event. * @param name Name of event.
* @param force If set to true, this forces the event to be created even if it's not being hooked. * @param force If set to true, this forces the event to be created even if it's not being hooked.
* Note that this will not force it if the event doesn't exist at all. * Note that this will not force it if the event doesn't exist at all.
@ -119,6 +122,8 @@ native Handle:CreateEvent(const String:name[], bool:force=false);
/** /**
* Fires a game event. * Fires a game event.
* *
* This function closes the event Handle after completing.
*
* @param event Handle to the event. * @param event Handle to the event.
* @param dontBroadcast Optional boolean that determines if event should be broadcast to clients. * @param dontBroadcast Optional boolean that determines if event should be broadcast to clients.
* @noreturn * @noreturn
@ -169,6 +174,11 @@ native GetEventInt(Handle:event, const String:key[]);
/** /**
* Sets the integer value of a game event's key. * Sets the integer value of a game event's key.
* *
* Integer value refers to anything that can be reduced to an integer.
* The various size specifiers, such as "byte" and "short" are still
* integers, and only refer to how much data will actually be sent
* over the network (if applicable).
*
* @param event Handle to the event. * @param event Handle to the event.
* @param key Name of event key. * @param key Name of event key.
* @param value New integer value. * @param value New integer value.