User Tools

Site Tools


addons:functions

Differences

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

Link to this comparison view

Next revision
Previous revision
addons:functions [2017/04/21 20:26]
atom0s created
addons:functions [2017/04/21 20:40]
atom0s
Line 7: Line 7:
 ---- ----
  
-==== Global Functions ​====+==== Namespaces ​====
  
-**AddIncomingPacket**+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 ​====
  
 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.
Line 19: 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.
Line 29: Line 40:
   * **Returns**   * **Returns**
     * //Function does not return a value.//     * //Function does not return a value.//
 +
 +----
 +==== ParseAutoTranslate ====
 +
 +Parses a string for auto-translate tags and converts them.
 +<code cpp>​string ParseAutoTranslate(msg,​ useBrackets);</​code>​
 +  * **Parameters**
 +    * msg - (string) The chat message to parse the auto-translate tags within.
 +    * useBrackets - (bool) True if the resulting string should include the brackets, false otherwise.
 +  * **Returns**
 +    * string - The parsed string.
 +
 +----
 +==== GetEntity ====
 +
 +Obtains an entity object from the given index.
 +<code cpp>​object GetEntity(index);</​code>​
 +  * **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.
 +<code cpp>​object GetPlayerEntity();</​code>​
 +  * **Parameters**
 +    * //Function has no parameters.//​
 +  * **Returns**
 +    * object - The entity object if valid, nil otherwise.
 +
 +----
addons/functions.txt · Last modified: 2017/04/22 00:11 (external edit)