oesleik/nfov

NPC Field of View

NFOV

NPC Field of View

Instalação

Faça o download da última versão em https://github.com/oesleik/nfov e inclua o código fonte:

<script src="nfov/dist/nfov.min.js"></script>

Utilização

Primeiro é necessário criar uma instância com as configurações desejadas:

var nfovInstance = new nfov({ ... })

Com a instância criada, basta chamar o método detect dentro do loop principal do jogo:

nfovInstance.detect(agent, targets, function (agent, target) {
  // do something...
})

Configurações

distance default 0
Distância máxima do raio de visão do agente.

angle default 0
Ângulo máximo de visão do agente.

angleUnit default NFOV.RADIANS
Unidade de medida do ângulo (NFOV.RADIANS ou NFOV.DEGREES).

orientation default NFOV.COUNTERCLOCKWISE
Sentido da orientação do ângulo (NFOV.COUNTERCLOCKWISE ou NFOV.CLOCKWISE).

grid default null
Tilemap do cenário no formato de um array de 2 dimensões. Ex:

[[1, 1, 1, 1, 1],
 [1, 0, 0, 0, 1],
 [1, 0, 0, 0, 1],
 [1, 0, 0, 0, 1],
 [1, 1, 1, 1, 1]]

tileSize default { width: 1, height: 1 }
Objeto com as dimensões dos tiles do tilemap no formato { width, height }.

acceptableTiles default []
Array com os valores dos tiles visíveis.

handler default nfov/handlers/basic
Função responsável por detectar objetos no campo de visão dos agentes.

Métodos

setDistance(distance)
Configura a distância máxima do raio de visão do agente.

getDistance()
Obtém a distância máxima do raio de visão do agente.

setAngle(angle)
Configura o ângulo máximo de visão do agente.

getAngle(angleUnit)
Obtém o ângulo máximo de visão do agente na unidade de medida configurada. Caso o parâmetro angleUnit seja informado, o ângulo é convertido para o formato informado.

setAngleUnit(angleUnit)
Configura a unidade de medida utilizada nos ângulos. Os valores possíveis são NFOV.RADIANS e NFOV.DEGREES.

getAngleUnit()
Obtém a unidade de medida utilizada nos ângulos.

setOrientation(orientation)
Configura o sentido da orientação utilizado nos ângulos. Os valores possíveis são NFOV.COUNTERCLOCKWISE e NFOV.CLOCKWISE.

getOrientation()
Obtém o sentido da orientação utilizado nos ângulos.

setGrid(grid)
Configura o tilemap do cenário no formato de um array de 2 dimensões. Ex:

[[1, 1, 1, 1, 1],
 [1, 0, 0, 0, 1],
 [1, 0, 0, 0, 1],
 [1, 0, 0, 0, 1],
 [1, 1, 1, 1, 1]]

getGrid()
Obtém o tilemap do cenário configurado.

setTileSize(widthOrObject, height)
Configura as dimensões dos tiles. O parâmetro widthOrObject pode ser um valor numérico representando a largura dos tiles ou um objeto no formato { width, height }.

getTileSize()
Obtém o objeto com as dimensões dos tiles no formato { width, height }.

setAcceptableTiles(tiles)
Configura um array com os tiles visíveis.

getAcceptableTiles()
Obtém um array com os tiles visíveis.

setHandler(handler)
Configura a função responsável por detectar objetos no campo de visão dos agentes. Esta função recebe como parâmetros a instância atual, os agentes, os objetos-alvo e a função de callback. Ex:

function handler (nfovInstance, agents, targets, callback) {
  // code...
}

getHandler()
Obtém a função responsável por detectar objetos no campo de visão dos agentes.

detect(agents, targets, callback)
Método responsável por detectar objetos no campo de visão do agente. Os parâmetros agents e targets podem ser informados como um objeto ou como um array de objetos, respeitando as propriedades necessárias para cada um, conforme apresentado mais abaixo.

O parâmetro callback referencia a função que será chamada quando um objeto estiver dentro do campo de visão de um agente recebendo como parâmetros o agente e objeto-alvo em questão. Ex:

function (agent, target) {
  console.log(agent.name + ' can see ' + target.name)
}

Objeto agent

Sprites utilizadas pelo Phaser ou Pixi são suportadas sem necessidade de configurações adicionais.

x
Coordenada do agente no eixo x.

y
Coordenada do agente no eixo y.

width
Largura do agente.

height
Altura do agente.

distance Opcional
Distância máxima do raio de visão do agente. Caso não informado, é utilizado o valor configurado na instância.

maxAngle Opcional
Ângulo máximo de visão do agente. Caso não informado, é utilizado o valor configurado na instância.

direction Opcional default 0
Direção em que o agente está apontando. O valor 0 indica o lado direito, isto é, x positivo e y 0.

Objeto target

Sprites utilizadas pelo Phaser ou Pixi são suportadas sem necessidade de configurações adicionais.

x
Coordenada do objeto no eixo x.

y
Coordenada do objeto no eixo y.

width
Largura do objeto.

height
Altura do objeto.