User Tools
addons:functions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
addons:functions [2015/11/20 01:22] atom0s |
addons:functions [2015/11/20 01:42] atom0s |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| The following page covers the functions that are built into Ashita's Addons.dll plugin. | The following page covers the functions that are built into Ashita's Addons.dll plugin. | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== Global Functions ==== | ||
| + | |||
| + | //void// **AddIncomingPacket**(packet, id, size); | ||
| + | * **Parameters** | ||
| + | * packet - The packet data. (Table) | ||
| + | * id - The id of the packet being sent. | ||
| + | * size - The size of the packet data to send. | ||
| + | * **Returns** | ||
| + | * //Function does not return a value.// | ||
| + | |||
| + | //void// **AddOutgoingPacket**(packet, id, size); | ||
| + | * **Parameters** | ||
| + | * packet - The packet data. (Table) | ||
| + | * id - The id of the packet being sent. | ||
| + | * size - The size of the packet data to send. | ||
| + | * **Returns** | ||
| + | * //Function does not return a value.// | ||
| + | |||
| + | //string// **ParseAutoTranslate**(str, addBrackets); | ||
| + | * **Parameters** | ||
| + | * str - The string to parse auto-translate strings from. | ||
| + | * addBrackets - Flag to determine if brackets should be readded to the parsed string. | ||
| + | * **Returns** | ||
| + | * The parsed string. | ||
| + | |||
| + | //object// **GetEntity**(index); | ||
| + | * **Parameters** | ||
| + | * index - The index of the entity to obtain. | ||
| + | * **Returns** | ||
| + | * The entity at the given index. | ||
| + | |||
| + | //object// **GetPlayerEntity**(); | ||
| + | * **Parameters** | ||
| + | * //Function has no arguments.// | ||
| + | * **Returns** | ||
| + | * The current players entity. | ||
| + | |||
| + | ==== Bitpack Functions ==== | ||
| + | |||
| + | //number// bitpack:unpackBitsBE(packet, bitOffset, bitLength); | ||
| + | * **Parameters** | ||
| + | * packet - The data to unpack values from. | ||
| + | * bitOffset - The bit offset to start unpacking at. | ||
| + | * bitLength - The number of bits to unpack. | ||
| + | * **Returns** | ||
| + | * The unpacked value. | ||
| + | |||
| + | //number// bitpack:unpackBitsBE(packet, byteOffset, bitOffset, bitLength); | ||
| + | * **Parameters** | ||
| + | * packet - The data to unpack values from. | ||
| + | * byteOffset - The byte offset within the data to unpack. | ||
| + | * bitOffset - The bit offset to start unpacking at. | ||
| + | * bitLength - The number of bits to unpack. | ||
| + | * **Returns** | ||
| + | * The unpacked value. | ||
| + | |||
| + | //number// bitpack:unpackBitsLE(packet, bitOffset, bitLength); | ||
| + | * **Parameters** | ||
| + | * packet - The data to unpack values from. | ||
| + | * bitOffset - The bit offset to start unpacking at. | ||
| + | * bitLength - The number of bits to unpack. | ||
| + | * **Returns** | ||
| + | * The unpacked value. | ||
| + | |||
| + | //number// bitpack:unpackBitsLE(packet, byteOffset, bitOffset, bitLength); | ||
| + | * **Parameters** | ||
| + | * packet - The data to unpack values from. | ||
| + | * byteOffset - The byte offset within the data to unpack. | ||
| + | * bitOffset - The bit offset to start unpacking at. | ||
| + | * bitLength - The number of bits to unpack. | ||
| + | * **Returns** | ||
| + | * The unpacked value. | ||
| ---- | ---- | ||
| Line 309: | Line 384: | ||
| * **Returns** | * **Returns** | ||
| * //Function does not return a value.// | * //Function does not return a value.// | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== Misc. Functions ==== | ||
| + | |||
| + | //void// **misc:open_url**(url); | ||
| + | * **Parameters** | ||
| + | * url - The website url to open. | ||
| + | * **Returns** | ||
| + | * //Function returns no value.// | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== Sound Functions ==== | ||
| + | |||
| + | //void// **sound:playsound**(file); | ||
| + | * **Parameters** | ||
| + | * file - sound The file to play. | ||
| + | * **Returns** | ||
| + | * //Function returns no value.// | ||
addons/functions.txt · Last modified: 2015/11/20 01:42 by atom0s
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
