Biblioteca Utils

.html ›› .html ››
Parent Previous Next

Biblioteca Utils

A biblioteca gui provê funções relacionadas às interfaces Lua Form.

Todas as funções estão contidas na unidade "utils.lua".


Exemplo de uso:

-- Primeiro, é necessário usar a unidade "utils.lua"
require("utils.lua");   

-- Agora é possível acessar as funções da biblioteca
Utils.FUNCAO_DA_BIBLIOTECA(Parametro1, Parametro2, ...);

FUNCAO_DA_BIBLIOTECA2(Parametro1, Parametro2, ...);



Funções da biblioteca utils


function clearInterval(intervalId)
ou
function Utils.clearInterval(intervalId)


Cancela o temporizador que setInterval havia previamente configurado.


Parâmetros:



function clearTimeout(timeoutId)
ou
function Utils.clearTimeout(timeoutId)


Cancela o temporizador que setTimeout havia previamente configurado.


Parâmetros:



function Utils.compareStringPtBr(strLeft, strRight)


Realiza comparação entre duas cadeias de caracteres de forma case-insensitive e ignorando acentuações


Retorna:


function lowercase(str)


Converte e retorna um string em caixa baixa (lower case)


Parâmetros:

       

Retorno: 


function uppercase(str)


Converte e retorna um string em caixa alta (upper case)


Parâmetros:

       

Retorno: 



function Utils.generateUniqueString()


Gera e retorna uma cadeia de caracteres globalmente única, isto é, um texto que nunca mais será gerado novamente por esta função


Retorno:




function isnumber(value)
ou
function isNumber(value)


Retorna true se o parâmetro "value" for um número, senão retorna false.



function round(value)


Arredonda "value" para o numero inteiro mais próximo e o retorna.



function removerAcentos(str)
ou
function Utils.removerAcentos(str)


Retorna o texto passado em "str" sem sua acentuação.



function Utils.removerFmtChat(str[, removerSmileys])


Retorna o texto passado em "str" sem os caracteres de formatação de cores/negrito/itálico que o RRPG aceita no chat.


Parâmetros:


Retorno:



function setInterval(callbackFunction, interval [, parametersToCallbackFunction])
ou
function Utils.setInterval(callbackFunction, interval [, parametersToCallbackFunction])


setInterval chama uma função qualquer após em intervalos de tempo especificado em milisegundos.


Parâmetros:


Retorno:


Observações:


function setTimeout(callbackFunction, interval [, parametersToCallbackFunction])
ou
function Utils.setTimeout(callbackFunction, interval [, parametersToCallbackFunction])


setTimeout chama uma função qualquer após uma quantidade específica de milisegundos se passarem.


Parâmetros:


Retorno:


Observações:




function Utils.sortPtBrArray(array)


Dado um array de strings (uma tabela lua indexada de 1 a n), ordena os valores lexicograficamente de forma case insensitive e ignorando acentuações.


Retorno:


function totable(str)
ou
function strToTable(str)
ou
function Utils.strToTable(str)


Converte o texto passado em "str" para uma tabela lua. O texto deve seguir o mesmo padrão que você usa ao declarar uma tabela lua quando está programando. 

Exemplo: "{nome='joão', idade=10, filhos={}}"



function tableToStr(table [, pretty])
ou
function Utils.tableToStr(table [, pretty])


Converte uma tabela LUA para string.


Parâmetros:


Retorno:




function Utils.binaryEncode(destArray, format, value [, startIndex])


Codifica um determinado valor em um formato binário.


Parâmetros:


Retorno:


Observações:



Formatos Binários:


Formato

Qtd. de Bytes

Descrição

"u8"

1

Um número entre 0 e 255 codificado como Unsigned Integer de 8 Bits (também conhecido como Byte)

"s8"

1

Um número entre -128 a 127 codificado como Signed Integer de 8 Bits.

"u16"

2

Um número entre 0 e 65535 codificado como Unsigned Integer de 16 bits (Também conhecido como Word) no padrão LittleEndian. 

"s16"

2

Um número entre -32768 e 32767 codificado como Signed Integer de 16 bits no padrão LittleEndian.

"u32"

4

Um número entre 0 e 4294967295 codificado como Unsigned Integer de 32 bits (Também conhecido como DoubleWord) no padrão LittleEndian.

"s32"

4

Um número entre -2147483648 e 2147483647 codificado como Signed Integer de 32 bits no padrão LittleEndian

 

"u64"

8

Um número entre 0 e (2^64) - 1 codificado como Unsigned Integer de 64 bits (Também conhecido como QuadWord) no padrão LittleEndian

"s64"

8

Um número entre -2^63 a (2^63) - 1 codificado como Signed Integer de 64 bits no padrão LittleEndian.

"float"

4

Um número de ponto flutuante de 4 bytes no padrão IEEE 754.

"double"

8

Um número de ponto flutuante de 8 bytes no padrão IEEE 754.

"ansi"

Varia

Uma cadeia de caracteres codificada em ANSI sem o terminador nulo.

"utf8"

Varia

Uma cadeia de caracteres codificada em UTF-8 sem o terminador nulo.

"utf16"

Varia

Uma cadeia de caracteres codificada em UTF-16 sem o terminador nulo.



function Utils.binaryDecode(sourceArray, format [, startIndex [, length]])


Interpreta um valor que está codificado em um formato binário.


Parâmetros:



Retorno:


Observações:

 


function Utils.getBinarySize(format)


Retorna quantos bytes um determinado formato binário ocupa.


Parâmetros:


Retorno:



function Utils.zlibCompress(sourceStream, destStream, [, level [, qtBytesInSource]])


Lê dados de um objeto stream fonte e, usando a biblioteca zLib, o compacta escrevendo o resultado em outro objeto stream.


Parâmetros:


Retorno:



function Utils.zlibDecompress(sourceStream, destStream)


Lê dados de um objeto stream fonte e, usando o a biblioteca zLib, o descompacta escrevendo o resultado em outro objeto stream.


Parâmetros:


Observações:


Retorno:




function Utils.zlibCompressAsync(sourceStream, destStream, level, qtBytesInSource, onFinishCallback, onErrorCallback)


Lê dados de um objeto stream fonte e, usando a biblioteca zLib, o compacta escrevendo o resultado em outro objeto stream.

A compactação se dá de forma assíncrona, isto é, em "background". Ótimo para compactar streams grandes e não "congelar" o programa durante o processo.


Parâmetros:


Observações:



function Utils.zlibDecompressAsync(sourceStream, destStream, onFinishCallback, onErrorCallback)


Lê dados de um objeto stream fonte e, usando o a biblioteca zLib, o descompacta escrevendo o resultado em outro objeto stream.

A descompactação se dá de forma assíncrona, isto é, em "background". Ótimo para descompactar streams grandes e não "congelar" o programa durante o processo.


Parâmetros:


Observações:



function Utils.newMemoryStream()


Cria e retorna um objeto stream que armazena os dados na memória RAM do dispositivo.



Observações:


Retorno:



function Utils.newTempFileStream()


Cria e retorna um objeto stream que armazena os dados em um arquivo temporário no dispositivo do usuário.



Observações:


Retorno:




function tryFinally(tryCallback, finallyCallback)
ou
function Utils.tryFinally(tryCallback, finallyCallback)


LUA não possui um operador try-finally para tratamento de exceções. Esta função é uma alternativa para o comportamento try-finally que o LUA não provê nativamente.


Executa a função "tryCallback", e: 


Parâmetros:




function colorToRGBA(color)
ou
function Utils.colorToRGBA(color)


Dado uma cor no formato string de cor, retorna os tons de Red, Green, Blue e Alpha da cor


Parâmetros:


Retorno:




function RGBAToColor(r, g, b, a)
ou
function Utils.RGBAToColor(r, g, b, a)


Dado tons de cores Red, Green, Blue e Alpha, retorna um string de cor que representa a cor.


Parâmetros:


Retorno:


Created with the Personal Edition of HelpNDoc: Revolutionize Your Documentation Output with HelpNDoc's Stunning User Interface