Propriedade

Tipo

Descrição

objectType

String "fogOfWar"

(Somente Leitura) Contém um texto que identifica o tipo do objeto - "fogOfWar"

enabled

Boolean

Define se o Fog of War está ativo no tabuleiro.

Apenas o mestre pode alterar esta propriedade.

ambientLight

Enumerado:

• "intense"
• "weak"
• "none"

Define qual é a iluminação ambiente do scene e pode ser:

• "intense" (Padrão) - Todo o tabuleiro recebe uma iluminação de ambiente Intensa. Exemplo: Ambiente à luz do sol.
  
  
• "weak" - Todo o tabuleiro recebe uma iluminação de ambiente fraca. Exemplo: Luz do luar.
  
  
• "none" - O tabuleiro não recebe nenhum tipo de iluminação do ambiente.

sharingMode

Enumerado:

• "individual"
• "group"

Define como ocorre o compartilhamento de visão entre os membros do grupo.

• "individual" (Padrão) - Cada membro do grupo enxerga apenas o que seus personagens enxergam.
  
  
• "group" - Cada membro do grupo enxerga o que todo o grupo enxerga.

Método

Descrição

fogOfWar:setArea(polygon, areaType)

Configura uma área do tabuleiro para se comportar como um determinado tipo de área de Fog of War.

Parâmetros:

• polygon - Um array de tabelas que contém propriedades x e y (em métrica de mundo), e cada cada item do array representando um vértice do polígono. Este é o polígono que será configurado.
• areaType - O tipo que esta área se comportará como. Pode ser um dos seguintes valores:
• "explorable" - Uma área à explorar
• "alwaysVisible" - Uma área sempre visível aos jogadores
• "alwaysHidden" - Uma área sempre escondida dos jogadores
• "semiVisible" - Uma área parcialmente visível aos jogadores

Observações:

• Apenas o mestre pode configurar áreas do tabuleiro

fogOfWar:resetAreas();

Reseta todas as áreas definidas no tabuleiro. Isto é, todo o tabuleiro passará a ser uma área do tipo "explorable".

Observações:

• Apenas o mestre pode configurar áreas do tabuleiro

fogOfWar:addOpaqueArea(polygon)

Adiciona uma área opaca/parede ao tabuleiro.

Parâmetros:

• polygon - Um array de tabelas que contém propriedades x e y (em métrica de mundo), e cada cada item do array representando um vértice do polígono. Este é o polígono que será configurado.

Observações:

• Apenas o mestre pode configurar áreas opacas do tabuleiro.

fogOfWar:removeOpaqueArea(polygon)

Remove uma área opaca/parede ao tabuleiro.

Parâmetros:

• polygon - Um array de tabelas que contém propriedades x e y (em métrica de mundo), e cada cada item do array representando um vértice do polígono. Este é o polígono que será removido das áreas opacas.

Observações:

• Apenas o mestre pode configurar áreas opacas do tabuleiro.

fogOfWar:resetOpaqueAreas();

Remove todas as áreas opacas do tabuleiro.

Observações:

• Apenas o mestre pode configurar áreas opacas do tabuleiro.

fogOfWar:testCircleMovementCollisionVsOpaqueAreas(centerX, centerY, r, offsetX, offsetY)

Verifica se um determinado círculo movendo colide com alguma área opaca/parede do tabuleiro.

Parâmetros:

• centerX - Centro do círculo no eixo X (em métrica de mundo) antes de realizar o movimento
• centerX - Centro do círculo no eixo Y (em métrica de mundo) antes de realizar o movimento.
• r - Raio do círculo (em métrica de mundo)
• offsetX - Define o sentido e comprimento do movimento do círculo no eixo X (em métrica de mundo) ... Exemplo: 1.0 significa que o círculo andou 1.0 métrica mundo para a direita.
• offsetX - dirX - Define o sentido e comprimento do movimento do círculo no eixo Y (em métrica de mundo) ... Exemplo: 1.0 significa que o círculo andou 1.0 métrica mundo para baixo.

Retorno:

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

• true se o ocorre uma colisão durante o movimento ou false
• Centro do círculo no eixo X (em métrica de mundo) onde ocorreu a colisão.
• Centro do círculo no eixo Y (em métrica de mundo) onde ocorreu a colisão.

Nome do evento

Descrição