DecodeString: Difference between revisions

Revision as of 23:48, 1 July 2018

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

string decodeString ( string algorithm, string input, table options )

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

Returns the decoded string if successful, false otherwise.

	Script Example Missing Function DecodeString needs a script example, help out by writing one.
	Before submitting check out Editing Guidelines Script Examples.

@@ Line 2: / Line 2: @@
 {{Shared function}}
 {{New feature/item|3.0156|1.5.5|11849|
-This function decodes a data string using a specified algorithm.
+This function decodes an encoded [[string]] using the specified algorithm. The counterpart of this function is [[encodeString]].
 }}
 ==Syntax==
 <syntaxhighlight lang="lua">
-string|false decodeString ( string algorithm, string input, table options )
+string decodeString ( string algorithm, string input, table options )
 </syntaxhighlight>
@@ Line 13: / Line 13: @@
 *'''algorithm:''' The algorithm to use.
 *'''input:''' The input to decode.
-*'''options :''' A table with options and other neccessary data for the algorithm, as detailed below
+*'''options:''' A [[table]] with options and other neccessary data for the algorithm, as detailed below.
 ===Options for each algorithm===
-* ''tea'':
+* ''tea'' ([https://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm Tiny Encryption Algorithm])
-** ''key'' (string) A key to tea-decode the input with
+** ''key'': A key to decode the input with.
 ===Returns===