Propriedade

Tipo

Descrição

mesa

Objeto Mesa

Somente leitura, contém o Objeto Mesa que representa em qual mesa este usuário está.

id

Integer

Somente leitura, contém o identificador interno do usuário.

login

String

Somente leitura, contém o login do usuário.

nick

String

Somente leitura, contém o nick do usuário.

avatar

String

Somente leitura, contém a URL da imagem de seu avatar.

capa

String

Somente leitura, contém a URL da imagem de capa do usuário.

isGold

Boolean

Somente leitura, contém true se o usuário for um assinante RRPG Gold.

isGoldPlus

Boolean

Somente leitura, contém true se o usuário for um assinante RRPG Gold Plus.

isRuby

Boolean

Somente leitura, contém true se o usuário for um assinante RRPG Ruby.

isAusente

Boolean

Somente leitura, contém true se o usuário estiver aparentemente ausente do computador.

isCnxDormente

Boolean

Somente leitura, contém true se a conexão do usuário está dormente, isto é, o usuário perdeu a conexão com o RRPG e está tentando a recuperar de volta.

isSessaoMobile

Boolean

Somente leitura, contém true se o usuário estiver conectado usando um dispositivo móvel (celular/tablet)

isEspectador

Boolean

Somente leitura, contém true se o usuário está no modo Espectador na mesa.

isJogador

Boolean

Somente leitura, contém true se o usuário estiver com o modo +jogador na mesa.

isMestre

Boolean

Somente leitura, contém true se o usuário estiver com o modo +mestre na mesa.

isJuggernaut

Boolean

Somente leitura, contém true se o usuário estiver com o modo +juggernaut na mesa.

isMudo

Boolean

Somente leitura, contém true se o usuário estiver com o modo +mudo na mesa.

isCego

Boolean

Somente leitura, contém true se o usuário estiver com o modo +cego na mesa.

haveVoice ou 

haveVoz

Boolean

Somente leitura, contém true se o usuário estiver com o modo +voz na mesa.

codigoInterno

Integer

Somente leitura, contém um número que identifica o jogador naquela mesa.

personagemPrincipal

Integer

Somente leitura, o código interno do item do personagem principal do jogador na mesa.

Este valor é o mesmo valor da propriedade "codigoInterno" dos objetos BibliotecaItem

O valor -1 significa que o jogador não tem personagem.

Método

Descrição

jogador:isType(typeName)

Retorna true se passado "jogador" como parâmetro.

jogador:requestSetCego(cego)

Requisita a alteração da propriedade isCego do jogador.

Parâmetros:

• cego - Booleano, onde true significa colocar o modo "+cego" e false colocar o modo "-cego".

Observações:

• A alteração do comportamento só ocorre após o servidor RRPG aprovar a mudança.
• Esta função não faz nada se o usuário do plug-in não for assinante do RRPG.

jogador:requestSetMudo(mudo)

Requisita a alteração da propriedade isMudo do jogador.

Parâmetros:

• mudo - Booleano, onde true significa colocar o modo "+mudo" e false colocar o modo "-mudo".

Observações:

• A alteração do comportamento só ocorre após o servidor RRPG aprovar a mudança.
• Esta função não faz nada se o usuário do plug-in não for assinante do RRPG.

jogador:requestSetVoz(voz)

Requisita a alteração da propriedade haveVoice do jogador.

Parâmetros:

• voz - Booleano, onde true significa colocar o modo "+voz" e false colocar o modo "-voz".

Observações:

• A alteração do comportamento só ocorre após o servidor RRPG aprovar a mudança.
• Esta função não faz nada se o usuário do plug-in não for assinante do RRPG.

jogador:requestSetJogador(isJogador)

Requisita a alteração da propriedade isJogador do usuário.

Parâmetros:

• isJogador - Booleano, onde true significa colocar o modo "+jogador" e false colocar o modo "-jogador".

Observações:

• A alteração do comportamento só ocorre após o servidor RRPG aprovar a mudança.
• Esta função não faz nada se o usuário do plug-in não for assinante do RRPG.

jogador:requestKick();

Requisita o kick (expulsão) do jogador da mesa.

Observações:

• O kick só ocorre após o servidor RRPG aprová-lo.
• Esta função não faz nada se o usuário do plug-in não for assinante do RRPG.

jogador:requestSetBarValue(index, currentValue, maxValue)

Requisita a alteração de valores em uma das barrinhas de status do jogador.

Parâmetros:

• index - um número que varia de 1 a 4, indicando qual barrinha deseja-se alterar os valores.
• currentValue - Um número representando o novo valor atual da barrinha ou nil se não quiser alterar este campo.
• maxValue - Um número representando o novo valor máximo da barrinha ou nil se não quiser alterar este campo.

Observações:

• A alteração só ocorre após o servidor RRPG aprová-la.
• Esta função não faz nada se o usuário do plug-in não for assinante do RRPG e o dono da mesa atual não for assinante do Gold Plus.

jogador:requestSetEditableLine(index, text)

Requisita a alteração de texto de uma das linhas digitáveis do jogador.

Parâmetros:

• index - um número que varia de 1 a 2, indicando de qual linha se deve alterar o texto.
• text - Uma cadeia de caracteres/texto contendo o novo texto que será aplicao à linha digitável especificada..

Observações:

• A alteração só ocorre após o servidor RRPG aprová-la.
• Esta função não faz nada se o usuário do plug-in não for assinante do RRPG e o dono da mesa atual não for assinante do Gold Plus.

jogador:getBarValue(index)

Retorna os valores atuais de uma das barrinhas de status do jogador.

Parâmetros:

• index - um número que varia de 1 a 4, indicando de qual barrinha se deseja obter informações.

Retorno:

Esta função retorna 3 valores na seguinte ordem:

• currentValue - Um número, valor atual da barrinha
• maxValue - Um número, valor máximo da barrinha
• percent - Um número, percentual da barrinha

Observações:

• Se index indicar uma barrinha que não está ativa na mesa, os três valores retornados (currentValue, maxValue e percent) serão nil.
• Se o usuário atual não tiver permissões para ver os números da barinha (isto é, a visibilidade está protegida), currentValue e maxValue serão retornados como nil enquanto percent trará uma porcentagem válida.

Exemplo:

local atual, maximo, percent = player:getBarValue(1);

jogador:getEditableLine(index)

Retorna os o texto atual de uma das linhas digitáveis do jogador.

Parâmetros:

• index - um número que varia de 1 a 2, indicando de qual linha se deseja obter informações.

Retorno:

• Uma cadeia de caracteres/texto contendo o que está escrito na linha digitável especificada.

<?xml version="1.0" encoding="UTF-8"?>
<form name="frmFichaTeste">         

        <button>
                <event name="onClick">
                        local msg = "";
                        local mesaDoPersonagem = rrpg.getMesaDe(sheet);
                        local jogadores = mesaDoPersonagem.jogadores;                

                        for i = 1, #jogadores, 1 do
                                local objJogador = jogadores[i];
                                msg = msg .. objJogador.nick .. " (" .. objJogador.login .. ")\n";
                        end;                       

                        showMessage(msg);
                </event>
        </button>
</form>