if (!documentation) var documentation = { start: { id: "start", name: "Welcome!", content: "" }, files: [] } documentation.files[documentation.files.length] = { file: "AHKA.ahk", items: [ { name: "Tutorials", id: "tutorials", items: [ { id: "tutorial1", name: "First Steps", content: "

" +"Sorry, this tutorial is under construction.

" +"Well, let's start!
" +"First of all, let's create an array! We do this with the NewArray function:" +"

myArray := AHKA_NewArray()
" +"Simple, right?
" +"An empty array is no use to anyone though, so let's fill it up with something! " +"For this, the Add function is used:" +"
myArray := AHKA_Add(myArray, \"Hello\")"
							+"\nmyArray := AHKA_Add(myArray, \"World\")
" +"Notice that the result of the function is assigned to the array, " +"this is because the function makes no change to the original array, " +"rather, it just returns the resultant new array.
" +"By default, the Add function needs the array you want to add something " +"to, and the value of what you want to add. You can also optionally specify an " +"index as the third parameter which would tell the function where you want it " +"to add the new value. If the index is left out, the function will add the value " +"to the end of the array." +"

", history: [ {version: "6.00", update: "History Record Begins"} ] }, /* Tutorial 1 */ { id: "tutorial2", name: "Going In Depth", content: "

Sorry, this tutorial is under construction.

", history: [ {version: "6.00", update: "History Record Begins"} ] }, /* Tutorial 2 */ { id: "tutorial3", name: "Doing It All", content: "

Sorry, this tutorial is under construction.

", history: [ {version: "6.00", update: "History Record Begins"} ] } /* Tutorial 3 */ ] }, { name: "User Functions API", id: "userapi", items: [ { id: "newarray", name: "NewArray", content: "Creates a new AHKArray.
" +"If parameter String is omitted, an empty AHKArray is generated.
" +"Otherwise, this function converts a non-HEXed AHKArray into a HEXed one if HEXing is enabled.
" +"Or simply returns the String it is given if HEXing is disabled.
" +"Sample Usage:
"
							+"newArray1 := AHKA_NewArray()"
							+"\n; newArray1->[]"
							+"\nnewArray2 := AHKA_NewArray(\"[1,2,3]\")"
							+"\n; newArray2->[1, 2, 3]"
							+"\nnewArray3 := AHKA_NewArray(\"[1,2,[31,32],4]\")"
							+"\n; newArray3->[1, 2, [31, 32], 4]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "0.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "String=\"\"", type: "String", info: "The String to convert to an AHKArray." }, ], returns: { name: "newArray", type: "String", info: "The generated AHKArray." } }, /* NewArray */ { id: "size", name: "Size", content: "Measures the length of a given AHKArray.
" +"Sample Usage:
"
							+"newArray := AHKA_NewArray()"
							+"\n; newArray->[]"
							+"\nnewArray := AHKA_Add(newArray, \"Hello\")"
							+"\n; newArray->[\"Hello\"]"
							+"\nnewArray := AHKA_Add(newArray, \"!\", 2)"
							+"\n; newArray->[\"Hello\", \"!\"]"
							+"\nnewArray := AHKA_Add(newArray, \"World\", -1)"
							+"\n; newArray->[\"Hello\", \"World\", \"!\"]"
							+"\nnewArrayLength := AHKA_Size(newArray)"
							+"\n; newArrayLength->3"
							+"\n\n"
							+"subArray := AHKA_NewArray()"
							+"\n; subArray->[]"
							+"\nsubArray := AHKA_Add(subArray, \"SubValue1\", 2)"
							+"\n; subArray->[\"SubValue1\"]"
							+"\nsubArray := AHKA_Add(subArray, \"SubValue2\", 2)"
							+"\n; subArray->[\"SubValue1\", \"SubValue2\"]"
							+"\nnewArray := AHKA_Add(newArray, subArray)"
							+"\n; newArray->[\"Hello\", \"World\", \"!\", [\"SubValue1\", \"SubValue2\"]]"
							+"\nnewArrayLength := AHKA_Size(newArray)"
							+"\n; newArrayLength->4"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "1"}, {version: "0.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray whose length should be measured." } ], returns: { name: "arrayLength", type: "Integer", info: "The number of elements within the AHKArray.
Note: All Sub-AHKArrays count as single elements." } }, /* Size */ { id: "add", name: "Add", content: "Adds a value to an existing AHKArray.
" +"Sample Usage:
"
							+"newArray := AHKA_NewArray()"
							+"\n; newArray->[]"
							+"\nnewArray := AHKA_Add(newArray, \"Hello\")"
							+"\n; newArray->[\"Hello\"]"
							+"\nnewArray := AHKA_Add(newArray, \"!\", 2)"
							+"\n; newArray->[\"Hello\", \"!\"]"
							+"\nnewArray := AHKA_Add(newArray, \"World\", -1)"
							+"\n; newArray->[\"Hello\", \"World\", \"!\"]"
							+"\nnewArray := AHKA_Add(newArray, AHKA_NewArray())"
							+"\n; newArray->[\"Hello\", \"World\", \"!\", []]"
							+"\nnewArray := AHKA_Add(newArray, \"2-D\", 4, 0)"
							+"\n; newArray->[\"Hello\", \"World\", \"!\", [\"2-D\"]]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "6"}, {version: "0.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to which the value should be added." }, { name: "Value", type: "String", info: "The value to add." }, { name: "Index1=0", type: "Integer", info: "Where to add the value within the AHKArray.
Index of 0 will add the value at the end of the AHKArray.
Index of >0 will add the value at the proper index (AHKArrays start at 1, not 0).
Value of <0 will add the value at the abs(Index) from the back of the AHKArray." }, { name: "Index2=\"\" ... Index10=\"\"", type: "Integer", info: "There may be up to 10 Index values for use with multi-dimensional arrays." } ], returns: { name: "finalArray", type: "String", info: "The new AHKArray with the added value.
Note: The original AHKArray variable is not modified." } }, /* Add */ { id: "get", name: "Get", content: "Retrieves a value from an existing AHKArray.
" +"Sample Usage:
"
							+"; Assume myArray->[\"A\", \"B\", [\"C1\", \"C2\"], \"D\"]"
							+"\nmyValue := AHKA_Get(myArray)"
							+"\n; myValue->\"D\""
							+"\nmyValue := AHKA_Get(myArray, 1)"
							+"\n; myValue->\"A\""
							+"\nmyValue := AHKA_Get(myArray, -1)"
							+"\n; myValue->[\"C1\", \"C2\"]"
							+"\nmyValue := AHKA_Get(myArray, -1, 2)"
							+"\n; myValue->\"C2\""
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "1"}, {version: "0.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray from which the value should be retrieved." }, { name: "Index1=0", type: "Integer", info: "Where to add the value within the AHKArray.
Index of 0 will get the value at the end of the AHKArray.
Index of >0 will get the value at the proper index (AHKArrays start at 1, not 0).
Value of <0 will get the value at the abs(Index) from the back of the AHKArray." }, { name: "Index2=\"\" ... Index10=\"\"", type: "Integer", info: "There may be up to 10 Index values for use with multi-dimensional arrays." } ], returns: { name: "Value", type: "String", info: "The value retrieved from the AHKArray.
Note: May be an AHKArray in case of multi-dimensional AHKArrays." } }, /* Get */ { id: "remove", name: "Remove", content: "Removes a value from an existing AHKArray.
" +"Sample Usage:
"
							+"; Assume myArray->[\"A\", \"B\", [\"C1\", \"C2\"], \"D\"]"
							+"\nmyArray := AHKA_Remove(myArray)"
							+"\n; myArray->[\"A\", \"B\", [\"C1\", \"C2\"]]"
							+"\nmyArray := AHKA_Remove(myArray, 1)"
							+"\n; myArray->[\"B\", [\"C1\", \"C2\"]]"
							+"\nmyArray := AHKA_Remove(myArray, -1)"
							+"\n; myArray->[[\"C1\", \"C2\"]]"
							+"\nmyArray := AHKA_Remove(myArray, 1, 2)"
							+"\n; myArray->[[\"C1\"]]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "2"}, {version: "0.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray from which the value should be removed." }, { name: "Index1=0", type: "Integer", info: "Where to add the value within the AHKArray.
Index of 0 will remove the value at the end of the AHKArray.
Index of >0 will remove the value at the proper index (AHKArrays start at 1, not 0).
Value of <0 will remove the value at the abs(Index) from the back of the AHKArray." }, { name: "Index2=\"\" ... Index10=\"\"", type: "Integer", info: "There may be up to 10 Index values for use with multi-dimensional arrays." } ], returns: { name: "newArray", type: "String", info: "The new AHKArray without the removed value.
Note: The original AHKArray variable is not modified." } }, /* Remove */ { id: "set", name: "Set", content: "Modifies a value in an existing AHKArray.
" +"Sample Usage:
"
							+"; Assume myArray->[\"A\", \"B\", [\"C1\", \"C2\"], \"D\"]"
							+"\nmyArray := AHKA_Set(myArray, \"mD\")"
							+"\n; myArray->[\"A\", \"B\", [\"C1\", \"C2\"], \"mD\"]"
							+"\nmyArray := AHKA_Set(myArray, \"mA\", 1)"
							+"\n; myArray->[\"mA\", \"B\", [\"C1\", \"C2\"], \"mD\"]"
							+"\nmyArray := AHKA_Set(myArray, \"mC2\", -1, 2)"
							+"\n; myArray->[\"mA\", \"B\", [\"C1\", \"mC2\"], \"mD\"]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "0.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray whose value should be modified." }, { name: "Index1=0", type: "Integer", info: "Where to add the value within the AHKArray.
Index of 0 will modify the value at the end of the AHKArray.
Index of >0 will modify the value at the proper index (AHKArrays start at 1, not 0).
Value of <0 will modify the value at the abs(Index) from the back of the AHKArray." }, { name: "Index2=\"\" ... Index10=\"\"", type: "Integer", info: "There may be up to 10 Index values for use with multi-dimensional arrays." } ], returns: { name: "newArray", type: "String", info: "The new AHKArray with the modified value.
Note: The original AHKArray variable is not modified." } }, /* Set */ { id: "split", name: "Split", content: "Creates a new AHKArray from a string.
" +"Sample Usage:
"
							+"newArray1 := AHKA_NewArray()"
							+"\n; newArray1->[]"
							+"\nnewArray2 := AHKA_Split(\"Testing\")"
							+"\n; newArray2->[\"T\", \"e\", \"s\", \"t\", \"i\", \"n\", \"g\"]"
							+"\nnewArray3 := AHKA_Split(\"I Am Jolly!\", \" \")"
							+"\n; newArray3->[\"I\", \"Am\", \"Jolly!\"]"
							+"\nnewArray4 := AHKA_Split(\"The Hay Had A Ham!\", \"H\", true)"
							+"\n; newArray4->[\"The \", \"ay \", \"ad A \", \"am!\"]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "2"}, {version: "4.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "String", type: "String", info: "The String to split." }, { name: "Delimeter=\"\"", type: "String", info: "The delimeter by which to split String." }, { name: "CaseSensitive=false", type: "Boolean", info: "Wheather to treat the delimeter as case-sensitive, or not." } ], returns: { name: "newArray", type: "String", info: "The generated AHKArray." } }, /* Split */ { id: "convert", name: "Convert", content: "Creates a new AHKArray from a standard AutoHotKey array.
" +"Sample Usage:
"
							+"myString := \"This is a test string.\""
							+"\nStringSplit, myString, myArray, myString, %A_Space%"
							+"\nnewArray := AHKA_Convert(\"myArray\")"
							+"\n; newArray->[\"This\", \"is\", \"a\", \"test\", \"string.\"]"
							+"\n"
							+"\n; Technical Note:"
							+"\n; This method tries to get the length of the array primarily by %myArray%, and if that does not work, by %myArray%0."
							+"\n; Meaning, if using a function like StringSplit which returns length in %myArray%0, make sure myArray doesn't have a value,"
							+"\n; otherwise, an empty array will be returned."
							+"\n; Example of bad usage:"
							+""
							+"\nmyString := \"This is a test string.\""
							+"\nStringSplit, myArray, myString, %A_Space%"
							+"\nmyArray := \"Nothing Here\""
							+"\nnewArray := AHKA_Convert(\"myArray\")"
							+""
							+"\n; newArray will then contain \"[]\""
							+""
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "1"}, {version: "1.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The name of the AutoHotkey array to convert." } ], returns: { name: "newArray", type: "String", info: "The generated AHKArray." } }, /* Convert */ { id: "sort", name: "Sort", content: "Sorts an AHKArray using 1 dimension.
" +"Sample Usage:
"
							+"myArray := AHKA_NewArray(\"[5,2,7,3,9,1,4,6,8]\")"
							+"\nmySortedArray1 := AHKA_Sort(myArray)"
							+"\n; mySortedArray1->[1, 2, 3, 4, 5, 6, 7, 8, 9]"
							+"\nmySortedArray2 := AHKA_Sort(myArray, 2)"
							+"\n; mySortedArray2->[9, 8, 7, 6, 5, 4, 3, 2, 1]"
							+"\nmySortedArray3 := AHKA_Sort(myArray, 1, 2)"
							+"\n; mySortedArray3->[5, 1, 2, 3, 4, 6, 7, 8, 9]"
							+"\nmySortedArray4 := AHKA_Sort(myArray, 2, 3, 7)"
							+"\n; mySortedArray4->[5, 2, 9, 7, 4, 3, 1, 6, 8]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "6"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The name of the AHKArray to sort." }, { name: "Type=1", type: "Integer", info: "Determines which way to sort the AHKArray." +"
If =1 AHKArray is sorted from smallest to largest." +"
If =2 AHKArray is sorted from largest to smallest." }, { name: "Start=0", type: "Integer", info: "Determines at which index to start sorting." +"
Values 0 and 1 both represent the first index of the AHKArray." +"
Values are on a start=1 based order." +"
Note: This is NOT an advanced index." }, { name: "End=-1", type: "Integer", info: "Determines at which index to end sorting." +"
Value -1 represents the last index of the AHKArray." +"
Values are on a start=1 based order." +"
Note: This is NOT an advanced index." } ], returns: { name: "newArray", type: "String", info: "The sorted AHKArray." } }, /* Sort */ { id: "swap", name: "Swap", content: "Swaps 2 indexes within an AHKArray.
" +"Sample Usage:
"
							+"myArray1 := AHKA_NewArray(\"[a,b,c,d,e,f]\")"
							+"\nmyArray2 := AHKA_Swap(myArray1, 2, 4)"
							+"\n; myArray2->[\"a\", \"d\", \"c\", \"b\", \"e\", \"f\"]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to swap values within." }, { name: "IndexA=0", type: "Integer", info: "The first value to swap within the AHKArray.
Index of 0 will get the value at the end of the AHKArray.
Index of >0 will get the value at the proper index (AHKArrays start at 1, not 0).
Value of <0 will get the value at the abs(Index) from the back of the AHKArray." }, { name: "IndexB=0", type: "Integer", info: "The second value to swap within the AHKArray.
Index of 0 will get the value at the end of the AHKArray.
Index of >0 will get the value at the proper index (AHKArrays start at 1, not 0).
Value of <0 will get the value at the abs(Index) from the back of the AHKArray." } ], returns: { name: "newArray", type: "String", info: "The resultant AHKArray." } }, /* Swap */ { id: "find", name: "Find", content: "Finds a specified value within an AHKArray.
" +"If value isn't found, returns 0.
" +"Sample Usage:
"
							+"myArray := AHKA_NewArray(\"[a,b,c,d,a,b,c,d,a,b,c,d]\")"
							+"\nmyIndex1 := AHKA_Search(myArray, \"a\")"
							+"\n; myIndex1->1"
							+"\nmyIndex2 := AHKA_Search(myArray, \"a\", 2)"
							+"\n; myIndex2->5"
							+"\nmyIndex3 := AHKA_Search(myArray, \"a\", -1)"
							+"\n; myIndex3->5"
							+"\nmyIndex4 := AHKA_Search(myArray, \"a\", 0)"
							+"\n; myIndex4->9"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to search within." }, { name: "Value", type: "String", info: "The value to search for." }, { name: "Number=1", type: "Integer", info: "If Number=0 Returns the index of last occurance of value in the AHKArray.
" +"If Number>0 Returns the index of the Number'th occurance of value in the AHKArray.
" +"If Number<0 Returns the index of (abs(Index)+1)'th occurance of value in array starting from the end of the AHKArray." } ], returns: { name: "newIndex", type: "Integer", info: "The index of the found Value." } }, /* Find */ { id: "minimum", name: "Minimum", content: "Finds the smallest value within an AHKArray.
" +"Sample Usage:
"
							+"myArray := AHKA_NewArray(\"[5,4,6,9,1,3,7,8,2]\")"
							+"\nmyIndex := AHKA_Minimum(myArray)"
							+"\n; myIndex->5"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to search within." } ], returns: { name: "newIndex", type: "Integer", info: "The index of the found Value." } }, /* Minimum */ { id: "maximum", name: "Maximum", content: "Finds the largest value within an AHKArray.
" +"Sample Usage:
"
							+"myArray := AHKA_NewArray(\"[5,4,6,9,1,3,7,8,2]\")"
							+"\nmyIndex := AHKA_Maximum(myArray)"
							+"\n; myIndex->4"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to search within." } ], returns: { name: "newIndex", type: "Integer", info: "The index of the found Value." } }, /* Maximum */ { id: "reverse", name: "Reverse", content: "Reverses the order of an AHKArray.
" +"Sample Usage:
"
							+"myArray1 := AHKA_NewArray(\"[5,4,6,9,1,3,7,8,2]\")"
							+"\nmyArray2 := AHKA_Reverse(myArray1)"
							+"\n; myArray2->[2, 8, 7, 3, 1, 9, 6, 4, 5]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "1"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to reverse." } ], returns: { name: "newArray", type: "String", info: "The reversed AHKArray." } }, /* Reverse */ { id: "trim", name: "Trim", content: "Trims an AHKArray by cutting off a specified number of indexes from beginning and end of the AHKArray.
" +"Sample Usage:
"
							+"myArray := AHKA_NewArray(\"[5,4,6,9,1,3,7,8,2]\")"
							+"\nmyArray1 := AHKA_Trim(myArray, 1)"
							+"\n; myArray1->[4, 6, 9, 1, 3, 7, 8, 2]"
							+"\nmyArray2 := AHKA_Trim(myArray, 0, 2)"
							+"\n; myArray2->[5, 4, 6, 9, 1, 3, 7]"
							+"\nmyArray3 := AHKA_Trim(myArray, 2, 3)"
							+"\n; myArray3->[6, 9, 1, 3]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to reverse." }, { name: "Starting=0", type: "Integer", info: "Number of indexes to cut off from the beginning of the AHKArray." }, { name: "Ending=0", type: "Integer", info: "Number of indexes to cut off from the end of the AHKArray." } ], returns: { name: "newArray", type: "String", info: "The trimmed AHKArray." } }, /* Trim */ { id: "merge", name: "Merge", content: "Merges a number of AHKArrays together by appending the values of one to the end of another.
" +"Sample Usage:
"
							+"myArray1 := AHKA_NewArray(\"[a,b]\")"
							+"myArray2 := AHKA_NewArray(\"[c,d]\")"
							+"myArray3 := AHKA_NewArray(\"[e,f]\")"
							+"myArray4 := AHKA_NewArray(\"[g,h]\")"
							+"\nmyArray5 := AHKA_Merge(myArray1, myArray2)"
							+"\n; myArray5->[\"a\", \"b\", \"c\", \"d\"]"
							+"\nmyArray6 := AHKA_Merge(myArray1, myArray2, myArray4, myArray3)"
							+"\n; myArray6->[\"a\", \"b\", \"c\", \"d\", \"g\", \"h\", \"e\", \"f\"]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "1"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array1", type: "String", info: "An AHKArray to merge.
Note: earlier indexes are merged to the beginning, later indexes are meged to the end." }, { name: "Array2", type: "String", info: "An AHKArray to merge." }, { name: "Array3=\"\" ... Array10=\"\"", type: "Integer", info: "There may be up to 10 AHKArrays specified to merge." } ], returns: { name: "newArray", type: "String", info: "The merged AHKArray." } }, /* Megre */ { id: "string", name: "String", content: "Converts an AHKArray into a simple string with no delimeters.
" +"Sample Usage:
"
							+"myArray := AHKA_NewArray(\"[1,2,3,4,5,6]\")"
							+"\nmyString := AHKA_String(myArray)"
							+"\n; myString->\"123456\""
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "1"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to convert." } ], returns: { name: "newString", type: "String", info: "The String representing the converted AHKArray." } }, /* String */ { id: "move", name: "Move", content: "Moves a value at a specified index to another specified index.
" +"Sample Usage:
"
							+"myArray1 := AHKA_NewArray(\"[1,2,3,4,5,6]\")"
							+"\nmyArray2 := AHKA_Move(myArray1, 2, 3)"
							+"\n; myArray2->[1, 3, 2, 4, 5, 6]"
							+"\nmyArray3 := AHKA_Move(myArray1, 3, 0)"
							+"\n; myArray3->[1, 2, 4, 5, 6, 3]"
							+"\nmyArray4 := AHKA_Move(myArray1, 1, -1)"
							+"\n; myArray4->[2, 3, 4, 5, 1, 6]"
							+"
", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "6.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ], parameters: [ { name: "Array", type: "String", info: "The AHKArray to move the value within." }, { name: "IndexA=0", type: "Integer", info: "Which value to move within the AHKArray.
Index of 0 will get the value at the end of the AHKArray.
Index of >0 will get the value at the proper index (AHKArrays start at 1, not 0).
Value of <0 will get the value at the abs(Index) from the back of the AHKArray." }, { name: "IndexB=0", type: "Integer", info: "Where to move the value within the AHKArray.
Index of 0 will get the value at the end of the AHKArray.
Index of >0 will get the value at the proper index (AHKArrays start at 1, not 0).
Value of <0 will get the value at the abs(Index) from the back of the AHKArray." } ], returns: { name: "newArray", type: "String", info: "The AHKArray resulting from the value being moved." } } /* Move */ ] }, { name: "Utility Functions API", id: "utilityapi", items: [ { id: "isarray", name: "IsArray", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "0.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* IsArray */ { id: "error", name: "Error", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* Error */ { id: "open", name: "Open", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* Open */ { id: "close", name: "Close", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* Close */ { id: "getfirstdimenstion", name: "GetFirstDimension", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "4"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* GetFirstDimensions */ { id: "getdimension", name: "GetDimension", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "2"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* GetDimension */ { id: "parsefirst", name: "ParseFirst", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "4"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* ParseFirst */ { id: "parse", name: "Parse", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* Parse */ { id: "unparse", name: "Unparse", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "2"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* Unparse */ { id: "floor", name: "Floor", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* Floor */ { id: "abs", name: "Abs", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* Abs */ { id: "chartohex", name: "CharToHex", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* CharToHex */ { id: "charfromhex", name: "CharFromHex", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* CharFromHex */ { id: "hex", name: "Hex", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "2"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* Hex */ { id: "hexarray", name: "HexArray", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "6.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* HexArray */ { id: "checkdebug", name: "CheckDebug", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "6.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* CheckDebug */ { id: "setdebug", name: "SetDebug", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "6.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* SetDebug */ { id: "getsimple", name: "GetSimple", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "2"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* GetSimple */ { id: "setsimple", name: "SetSimple", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "0"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* SetSimple */ { id: "mergesimple", name: "MergeSimple", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "1"}, {version: "5.xx", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* MergeSimple */ { id: "addsimple", name: "AddSimple", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "6"}, {version: "6.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] }, /* AddSimple */ { id: "removesimple", name: "RemoveSimple", content: "

" +"Sorry, this function's documentation is under construction." +"

", history: [ {version: "Bugs Known", update: "0"}, {version: "Bugs Fixed", update: "2"}, {version: "6.00", update: "Function Created"}, {version: "6.00", update: "History Record Begins"} ] } /* RemoveSimple */ ] } ] };