Objeto Personagem

.html ›› .html ›› .html ››
Parent Previous Next

Objeto Personagem

Este objeto representa um personagem na biblioteca de uma mesa no RRPG Firecast.


Herança

O Objeto Personagem possui todas as características de um Objeto BibliotecaItem. Veja:


Características

Além das características herdadas, o Objeto Personagem também possui as seguintes características:

Propriedades e atributos

Propriedade

Tipo

Descrição

dataType

String

Somente leitura, contém o dataType da ficha do personagem, isto é, em qual formato de dados está a ficha do personagem.


editionBlocked

escritaBloqueada

Boolean


Somente leitura, contém true se a ficha do personagem estiver com marcada como edição bloqueada.


Para alterar esta propriedade, utilize o método asyncUpdate deste objeto.


avatar

String

Somente leitura, contém a URL da imagem do personagem.

Para alterar esta propriedade, utilize o método asyncUpdate deste objeto.


bar0Val
bar1Val

bar2Val

bar3Val


Integer

Read-only, the current value for the corresponding character bar.


To modify this attribute, utilize this object's asyncUpdate method.


bar0Max
bar1Max

bar2Max

bar3Max


Integer

Read-only, the maximum value for the corresponding character bar.


To modify this attribute, utilize this object's asyncUpdate method.


edtLine0

edtLine1


String

Read-only, content for the corresponding character editable line.


To modify this attribute, utilize this object's asyncUpdate method.




Métodos


Método

Descrição

personagem:isType(typeName)


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


personagem:asyncOpenNDB([options])

Asynchronously opens the NodeDatabase of the character.


Arguments:

  • (Optional) options - A Lua table describing additional settings that may contain:
    • skipLoad - a boolean. If true, the returned Promise will be resolved before the load process is finished. If true, you will receive a “Loading node” instead of a “Loaded node”. Default: false


Return:

  • a Promise for a Node Object. Unless options.skipLoad is true, the Promise resolves after all data is downloaded and available for use.


Remarks:

  • Each character possesses only one NodeDatabase.
  • Changes made to the NodeDatabase opened by this function are automatically synchronized with other users who have also opened the same NodeDatabase.
  • If the user leaves the room, the NodeDatabase will have its connection dropped and will no longer synchronize changes.
  • By default, users with +GM mode and the character owner can read and write the NodeDatabase, while other users can only read.


Example:


local promise = character:asyncOpenNDB();           

local node = await(promise);

-- variable node is ready to be used here


personagem:loadSheetNDB(callback)

FUNÇÃO DESCONTINUADA! Utilize a função personagem:asyncLoadNDB() ao invés desta.


Abre um NodeDatabase do personagem que está fisicamente armazenado no servidor do RRPG.


Parâmetros:

    • callback - Uma função que será invocada quando o NodeDatabase for carregado ou quando ocorrer um erro no carregamento.
      • Quando o carregamento for bem sucedido, a função callback será chamada contendo o Objeto Nodo raiz do NodeDatabase no primeiro parâmetro. Este node é o mesmo equivalente ao "sheet" do lua form de fichas.
      • Quando ocorrer algum erro no carregamento, a função callback será chamada contendo nil no primeiro parâmetro.


Observações:

    • Esta função é assíncrona, isto é, o código LUA continua sua execução normal enquanto o NDB é carregado em segundo plano. É preciso informar o parâmetro "callback" para obter o NodeDatabase carregado.
    • Cada personagem possui apenas um NodeDatabase.
    • Alterações feitas no NodeDatabase aberto por esta função são automaticamente sincronizadas com os outros usuários que também abriram o mesmo NodeDatabase, inclusives com a ficha aberta localmente (se tiver aberta).
    • Se o usuário sair da mesa, o NodeDatabase terá sua conexão cortada e não mais sincronizará as alterações.
    • Por padrão, os usuários com o modo +mestre e o dono do personagem podem ler e alterar o NodeDatabase enquanto os demais usuários podem apenas ler valores.
    • A função "callback" pode demorar um pouco para ser chamada, pois um download precisará ser feito se o nodedatabase do personagem ainda não foi carregado localmente.
    • O que acontece ao executar esta função em um personagem que utiliza SDK 2 ou SDK 1:
      • Um nodedatabase é carregado mesmo assim, porém as alterações feitas aqui não são refletidas na ficha pois os dados reais dela estão salvos em outro formato e outro lugar.



Created with the Personal Edition of HelpNDoc: Free PDF documentation generator