DecodeString: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Modify build numbers)
(Callback is Optional argument not required)
 
(3 intermediate revisions by 2 users not shown)
Line 13: Line 13:
*'''algorithm:''' The algorithm to use.
*'''algorithm:''' The algorithm to use.
*'''input:''' The input to decode.
*'''input:''' The input to decode.
*'''options:''' A [[table]] with options and other necessary data for the algorithm, as detailed below.


===Options for each algorithm===
===Options for each algorithm===
Line 35: Line 34:
** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)
** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)
|22408}}
|22408}}
{{Added feature/item|1.6.0|1.6.1|23219|
* ''zlib'' ([https://en.wikipedia.org/wiki/Zlib Zlib Compression Algorithm])
** '''format''': a string or number that defines compression format. (gzip, zlib, raw or [https://www.zlib.net/manual.html#Advanced window size number]) (default: auto) (please note that automatic determination of format may not be reliable in some cases due to the nature of compression algorithm)
|23219}}


===Optional Arguments===
===Optional Arguments===
Line 42: Line 45:


==Example==  
==Example==  
Adds an ''/decode'' command in which you can provide an algorithm, key and data to decode.


<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
Adds a ''/decode'' command in which you can provide an algorithm, key and data to decode.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler("decode",  
addCommandHandler("decode",  

Latest revision as of 20:37, 1 November 2025

This function decodes an encoded string using the specified algorithm. The counterpart of this function is encodeString.

Syntax

string decodeString ( string algorithm, string input, [table options, function callback] )

Required Arguments

  • algorithm: The algorithm to use.
  • input: The input to decode.

Options for each algorithm

  • aes128 (Advanced Encryption Standard in CTR mode)
    • key: a key to decode the input with.
    • iv: the initialization vector that was generated by encodeString for this combination of data and encryption algorithm.
BETA: NEW FEATURE (BUILD: 1.6.1 r22408)
BETA: NEW FEATURE (BUILD: 1.6.1 r22408)
BETA: NEW FEATURE (BUILD: 1.6.1 r23219)
  • zlib (Zlib Compression Algorithm)
    • format: a string or number that defines compression format. (gzip, zlib, raw or window size number) (default: auto) (please note that automatic determination of format may not be reliable in some cases due to the nature of compression algorithm)

Optional Arguments

  • callback: providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.

Returns

Returns the decoded string if successful, false otherwise. If a callback was provided, the decoded string is argument to the callback.

Example

Click to collapse [-]
Server

Adds a /decode command in which you can provide an algorithm, key and data to decode. 

addCommandHandler("decode", 
    function(player, _, algorithm, key, ...)
        if algorithm and key then
            local text = table.concat({...}, " ")
            if type(text) == "string" and text ~= "" then
                local decoded = decodeString(algorithm, text, { key = key })
                if decoded then
                    outputChatBox("The result of " .. algorithm .. " decoding is: " .. decoded, player)
                else
                    outputChatBox("Failed to decode. Make sure that all arguments are valid.", player, 255, 0, 0)
                end
            else
                outputChatBox("Please specify text in the command.", player, 255, 0, 0)
            end
        else
            outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
        end
    end
)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/DecodeString?oldid=82584"