Gaming
 

API strbyte

From WoWWiki

"strbyte" is a shortcut for the standard Lua library function "string.byte". They can both be used interchangeably.

Returns the numerical code of a character in a string.

indexByte = string.byte(s [, index])


Arguments

s [, index]
String - The string to get the numerical code from
index 
Number - Optional argument specifying the index of the character to get the byte value of


Returns

indexByte 
Number - The byte value of the character at the specified position or nil if the index is invalid


Example

> = string.byte("ABCDE")      -- no index, so the first character
65
> = string.byte("ABCDE",1)    -- indexes start at 1
65
> = string.byte("ABCDE",0)    -- we're not using C
> = string.byte("ABCDE",100)  -- index out of range, no value returned


Details

The first valid index is 1.
The last valid index is the length of the string.


 


This is a Lua function and documented as part of the World of Warcraft API