User Tools

Site Tools


addons:functions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
addons:functions [2017/04/21 20:29]
atom0s
addons:functions [2017/04/22 00:11] (current)
Line 7: Line 7:
 ---- ----
  
 +==== Namespaces ====
 +
 +These are the global namespaces you can use within an addon:
 +
 +^ Namespace ^ Description ^
 +| [[addons:​functions:​bits]] | Functions to work with bits and bytes. |
 +| [[addons:​functions:​file]] | Functions to work with files and folders. |
 +| [[addons:​functions:​gui]] | Functions to work with the ImGui system. |
 +| [[addons:​functions:​memory]] | Functions to work with the client memory. (Reading and writing.) |
 +| [[addons:​functions:​misc]] | Misc. functions to work with various things. |
 +| [[addons:​functions:​regex]] | Functions related to regular expressions. |
 +
 +----
 ==== AddIncomingPacket ==== ==== AddIncomingPacket ====
  
 Sends a packet to the client as if the server had sent it. Sends a packet to the client as if the server had sent it.
-<code cpp>void AddIncomingPacket(id,​ packet);</​code>+<sxh lua>void AddIncomingPacket(id,​ packet);</​sxh>
   * **Parameters**   * **Parameters**
     * id - (number) The id of the packet being sent.     * id - (number) The id of the packet being sent.
Line 17: Line 30:
     * //Function does not return a value.//     * //Function does not return a value.//
  
 +----
 ==== AddOutgoingPacket ==== ==== AddOutgoingPacket ====
  
 Sends a packet to the server as if the client had sent it. Sends a packet to the server as if the client had sent it.
-<code cpp>void AddOutgoingPacket(id,​ packet);</​code>+<sxh lua>void AddOutgoingPacket(id,​ packet);</​sxh>
   * **Parameters**   * **Parameters**
     * id - (number) The id of the packet being sent.     * id - (number) The id of the packet being sent.
Line 28: Line 41:
     * //Function does not return a value.//     * //Function does not return a value.//
  
 +----
 ==== ParseAutoTranslate ==== ==== ParseAutoTranslate ====
  
 Parses a string for auto-translate tags and converts them. Parses a string for auto-translate tags and converts them.
-<code cpp>string ParseAutoTranslate(msg,​ useBrackets);</​code>+<sxh lua>string ParseAutoTranslate(msg,​ useBrackets);</​sxh>
   * **Parameters**   * **Parameters**
     * msg - (string) The chat message to parse the auto-translate tags within.     * msg - (string) The chat message to parse the auto-translate tags within.
Line 37: Line 51:
   * **Returns**   * **Returns**
     * string - The parsed string.     * string - The parsed string.
 +
 +----
 +==== GetEntity ====
 +
 +Obtains an entity object from the given index.
 +<sxh lua>​object GetEntity(index);</​sxh>​
 +  * **Parameters**
 +    * index - (number) The index of the entity to obtain.
 +  * **Returns**
 +    * object - The entity object if valid, nil otherwise.
 +
 +----
 +==== GetPlayerEntity ====
 +
 +Obtains the player entity object.
 +<sxh lua>​object GetPlayerEntity();</​sxh>​
 +  * **Parameters**
 +    * //Function has no parameters.//​
 +  * **Returns**
 +    * object - The entity object if valid, nil otherwise.
 +
 +----
addons/functions.1492831794.txt.gz · Last modified: 2017/04/21 20:29 by atom0s