EncodeString: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (corrected typo)
(Added code example)
Line 22: Line 22:
Returns the encoded string if successful, ''false'' otherwise.
Returns the encoded string if successful, ''false'' otherwise.


==Example==
==Example==  
{{Needs Example}}
'''Example 1:'''
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("encode",
    function(player, _, algorithm, key, ...)
        if algorithm and key then
            local text = table.concat({...}, " ")
            if type(text) == "string" and text ~= "" then
                local encoded = encodeString(algorithm, text, { key = key })
                if encoded then
                    outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded, player)
                else
                    outputChatBox("Failed to encode. 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
)
</syntaxhighlight>
</section>
 
'''Example 2:'''
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("encode",
    function(_, algorithm, key, ...)
        if algorithm and key then
            local text = table.concat({...}, " ")
            if type(text) == "string" and text ~= "" then
                local encoded = encodeString(algorithm, text, { key = key })
                if encoded then
                    outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded)
                else
                    outputChatBox("Failed to encode. Make sure that all arguments are valid.", 255, 0, 0)
                end
            else
                outputChatBox("Please specify text in the command.", 255, 0, 0)
            end
        else
            outputChatBox("Invalid algorithm and/or key.", 255, 0, 0)
        end
    end
)
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Utility functions}}
{{Utility functions}}

Revision as of 23:53, 9 April 2018

This function encodes a string using a specified algorithm.

Syntax

string|false encodeString ( string algorithm, string input, table options )

Required Arguments

  • algorithm: The algorithm to use.
  • input: The input to encode.
  • options : A table with options and other neccessary data for the algorithm, as detailed below

Options for each algorithm

  • tea:
    • key (string) A key to tea-encode the input with

Returns

Returns the encoded string if successful, false otherwise.

Example

Example 1:

Click to collapse [-]
Server
addCommandHandler("encode", 
    function(player, _, algorithm, key, ...)
        if algorithm and key then
            local text = table.concat({...}, " ")
            if type(text) == "string" and text ~= "" then
                local encoded = encodeString(algorithm, text, { key = key })
                if encoded then
                    outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded, player)
                else
                    outputChatBox("Failed to encode. 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
)

Example 2:

Click to collapse [-]
Client
addCommandHandler("encode", 
    function(_, algorithm, key, ...)
        if algorithm and key then
            local text = table.concat({...}, " ")
            if type(text) == "string" and text ~= "" then
                local encoded = encodeString(algorithm, text, { key = key })
                if encoded then
                    outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded)
                else
                    outputChatBox("Failed to encode. Make sure that all arguments are valid.", 255, 0, 0)
                end
            else
                outputChatBox("Please specify text in the command.", 255, 0, 0)
            end
        else
            outputChatBox("Invalid algorithm and/or key.", 255, 0, 0)
        end
    end
)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/EncodeString?oldid=54676"