Pular para o conteúdo
AstraDOCS

Astra.Components.NavAgent

Astra 0.3.0-preview.20261009Referência de assinaturas

Agente de navegação: Anda pela malha até um destino, desviando de outros agentes. Família Navegação · Movimento.

Namespace: Astra.Components · Assembly: Astra.Scripting · Tipo: Struct

readonly struct Astra.Components.NavAgent

Agente de navegação: Anda pela malha até um destino, desviando de outros agentes. Família Navegação · Movimento.

Referência estudada: https://docs.unity3d.com/6000.0/Documentation/Manual/class-NavMeshAgent.html

Interfaces: Astra.Components.IComponentFacade<Astra.Components.NavAgent>.

Hierarquia → selecione o objeto → Inspector → Adicionar componente → Navegação / Movimento → Agente de navegação.

No Behavior em Play, obtenha a fachada com Object.GetComponent<NavAgent>(); trate null antes de usar. Para outro objeto, resolva uma ObjectReference e consulte nesse objeto. Criar new NavAgent(component) envolve um componente existente; não adiciona um componente à cena.

Câmera e navegação: o membro presente nesta referência pertence ao contrato atual. O roadmap registra a família; não há promessa/data individual de evolução para cada membro. Membros ainda sem explicação especializada são indicados como revisão editorial pendente.

Para ler os campos e recursos pelo caminho do editor, use mapa de acesso.

Consulte também Agente de navegação para propriedades, valores iniciais, requisitos e edição em Play.

Membro Categoria
.ctor Method
HasPath Method
IsOnLink Method
OnDestinationReached Method
OnLinkEntered Method
OnPathFailed Method
PathStatus Method
RemainingDistance Method
Remove Method
Resume Method
SetDestination Method
Stop Method
Velocity Method
Warp Method
Wrap Method
Acceleration Property
AngularSpeed Property
AutoBraking Property
Avoidance Property
BaseOffset Property
Component Property
DifficultCost Property
Enabled Property
Height Property
InstanceId Property
IsAlive Property
JumpCost Property
Object Property
Radius Property
RepathDistance Property
Speed Property
StoppingDistance Property
Surface Property
Target Property
TypeId Property
UpdateRotation Property
UseDifficult Property
UseJump Property

.ctor

public NavAgent(Astra.Component component)

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Constrói o tipo pela assinatura declarada. Um construtor de fachada envolve um componente existente; um record de configuração só tem efeito quando atribuído ao consumidor.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
component Astra.Component

HasPath

public bool HasPath()

Tem caminho. Verdadeiro enquanto há um destino válido

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Tem caminho. Verdadeiro enquanto há um destino válido

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

IsOnLink

public bool IsOnLink()

Em link. Verdadeiro durante a travessia de um Link

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Em link. Verdadeiro durante a travessia de um Link

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

OnDestinationReached

public Astra.ComponentSubscription OnDestinationReached(Astra.Behavior owner, System.Action<Astra.ComponentEventArgs> handler)

Chegou. Emitido uma vez quando o caminho restante fica abaixo da distância de parada

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Chegou. Emitido uma vez quando o caminho restante fica abaixo da distância de parada

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
owner Astra.Behavior
handler System.Action&lt;Astra.ComponentEventArgs&gt;

OnLinkEntered

public Astra.ComponentSubscription OnLinkEntered(Astra.Behavior owner, System.Action<Astra.ComponentEventArgs> handler)

Entrou no link. Emitido quando o agente começa a atravessar um Link

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Entrou no link. Emitido quando o agente começa a atravessar um Link

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
owner Astra.Behavior
handler System.Action&lt;Astra.ComponentEventArgs&gt;

OnPathFailed

public Astra.ComponentSubscription OnPathFailed(Astra.Behavior owner, System.Action<Astra.ComponentEventArgs> handler)

Caminho falhou. Emitido quando o destino não tem caminho

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Caminho falhou. Emitido quando o destino não tem caminho

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
owner Astra.Behavior
handler System.Action&lt;Astra.ComponentEventArgs&gt;

PathStatus

public long PathStatus()

Estado do caminho. 0 sem caminho, 1 completo, 2 parcial, 3 inválido

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Estado do caminho. 0 sem caminho, 1 completo, 2 parcial, 3 inválido

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

RemainingDistance

public double RemainingDistance()

Distância restante. Comprimento do caminho até o destino; infinito sem caminho

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Distância restante. Comprimento do caminho até o destino; infinito sem caminho

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Remove

public void Remove()

Remove a instância pelo ciclo nativo; dependências e ownership podem recusar.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Solicita remoção pelo lifecycle nativo; dependências e regras de Play podem recusar.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Resume

public void Resume()

Retomar. Volta ao último destino depois de Parar

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Retomar. Volta ao último destino depois de Parar

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

SetDestination

public bool SetDestination(System.Numerics.Vector3 point)

Ir para. Calcula o caminho e começa a andar; falso quando o ponto está longe da malha

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Ir para. Calcula o caminho e começa a andar; falso quando o ponto está longe da malha

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
point System.Numerics.Vector3

Stop

public void Stop()

Parar. Para no lugar e guarda o destino para Retomar

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Parar. Para no lugar e guarda o destino para Retomar

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Velocity

public System.Numerics.Vector3 Velocity()

Velocidade. Velocidade pedida pela multidão neste quadro

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Velocidade. Velocidade pedida pela multidão neste quadro

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Warp

public bool Warp(System.Numerics.Vector3 point)

Teleportar. Move o objeto e o agente para o ponto mais próximo da malha

Executado no mundo de Play; fora dele lança WorldException NotRunning.

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Teleportar. Move o objeto e o agente para o ponto mais próximo da malha

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
point System.Numerics.Vector3

Wrap

public static Astra.Components.NavAgent Wrap(Astra.Component component)

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Envolve um Component existente após conferir TypeId; não cria componente.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
component Astra.Component

Acceleration

public float Acceleration { get; set; }

Aceleração (m/s²)

Faixa válida: 0 a 1000.

Caminho: Inspector → Agente de navegação → Movimento; ou fachada C# em um Behavior.

Uso: Aceleração: Quanto a velocidade pode mudar por segundo, em m/s². Também limita a frenagem ao chegar.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

AngularSpeed

public float AngularSpeed { get; set; }

Giro (°/s). Velocidade de giro para a direção do movimento

Faixa válida: 0 a 3600.

Caminho: Inspector → Agente de navegação → Movimento; ou fachada C# em um Behavior.

Uso: Giro: Velocidade de giro, em graus/s, para virar o objeto na direção do movimento (Personagem e própria pose).

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

AutoBraking

public bool AutoBraking { get; set; }

Frear ao chegar. Desacelera perto do destino; desligado mantém a velocidade até a distância de parada

Caminho: Inspector → Agente de navegação → Movimento; ou fachada C# em um Behavior.

Uso: Frear ao chegar: Desacelera antes do destino para parar na distância de parada. Desligado mantém a velocidade até chegar.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Avoidance

public Astra.Components.NavAgent.AvoidanceOption Avoidance { get; set; }

Desvio de agentes. Qualidade da amostragem de velocidades contra outros agentes

Caminho: Inspector → Agente de navegação → Corpo; ou fachada C# em um Behavior.

Uso: Desvio de agentes: Qualidade do desvio entre agentes: Nenhum desliga; Alto amostra mais velocidades e custa mais.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

BaseOffset

public float BaseOffset { get; set; }

Deslocamento da base (m). Altura do pivô acima da malha quando o agente move o próprio objeto

Faixa válida: -100 a 100.

Caminho: Inspector → Agente de navegação → Corpo; ou fachada C# em um Behavior.

Uso: Deslocamento da base: Altura do pivô acima da malha, em metros, quando o agente move a própria pose.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Component

public Astra.Component Component { get; }

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Handle genérico da instância, usado para operações de reflexão e recursos.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

DifficultCost

public float DifficultCost { get; set; }

Custo da área difícil (×). Multiplica o comprimento percorrido nessa área

Faixa válida: 1 a 1000.

Caminho: Inspector → Agente de navegação → Áreas; ou fachada C# em um Behavior.

Uso: Custo da área difícil: Multiplicador do custo da área Difícil. Com 1 atravessa; valores altos contornam.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Enabled

public bool Enabled { get; set; }

Ativo. Desligado sai da multidão e para de mover o objeto

Caminho: Inspector → Agente de navegação → Geral; ou fachada C# em um Behavior.

Uso: Ativo: Desligado sai da multidão e para de mover o objeto; o destino guardado continua no Play.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Height

public float Height { get; set; }

Altura (m)

Faixa válida: 0.05 a 100.

Caminho: Inspector → Agente de navegação → Corpo; ou fachada C# em um Behavior.

Uso: Altura: Altura do agente para o desvio, em metros.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

InstanceId

public ulong InstanceId { get; }

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Distingue a instância no mesmo objeto; importante para componentes múltiplos.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

IsAlive

public bool IsAlive { get; }

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Validade do handle no mundo/geração atuais. Remoção e novo Play invalidam a referência.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

JumpCost

public float JumpCost { get; set; }

Custo do salto (×)

Faixa válida: 1 a 1000.

Caminho: Inspector → Agente de navegação → Áreas; ou fachada C# em um Behavior.

Uso: Custo do salto: Multiplicador do custo de links e áreas de Salto. Maior faz o caminho evitar saltos quando há alternativa.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Object

public Astra.GameObject Object { get; }

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Objeto dono deste componente; use para resolver composição.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Radius

public float Radius { get; set; }

Raio (m). Usado no desvio entre agentes

Faixa válida: 0.05 a 50.

Caminho: Inspector → Agente de navegação → Corpo; ou fachada C# em um Behavior.

Uso: Raio: Raio usado no desvio entre agentes, em metros. Não altera a malha assada; use o raio da Superfície para isso.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

RepathDistance

public float RepathDistance { get; set; }

Refazer caminho a (m). O alvo precisa se mover isto para o caminho ser refeito

Faixa válida: 0.05 a 100.

Caminho: Inspector → Agente de navegação → Movimento; ou fachada C# em um Behavior.

Uso: Refazer caminho a: Quanto o objeto seguido precisa se mover, em metros, para o caminho ser refeito.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Speed

public float Speed { get; set; }

Velocidade (m/s)

Faixa válida: 0 a 1000.

Caminho: Inspector → Agente de navegação → Movimento; ou fachada C# em um Behavior.

Uso: Velocidade: Velocidade máxima pedida à multidão, em m/s. Com Personagem, o agente nunca passa da velocidade do próprio Personagem.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

StoppingDistance

public float StoppingDistance { get; set; }

Distância de parada (m). Chega quando o caminho restante fica abaixo disto

Faixa válida: 0 a 1000.

Caminho: Inspector → Agente de navegação → Movimento; ou fachada C# em um Behavior.

Uso: Distância de parada: Distância do destino em que o agente considera que chegou e para; emite o evento de chegada uma vez.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Surface

public Astra.ObjectReference Surface { get; set; }

Superfície. Malha usada pelo agente; vazio escolhe a superfície que contém o objeto

Caminho: Inspector → Agente de navegação → Geral; ou fachada C# em um Behavior.

Uso: Superfície: Superfície cuja malha o agente usa; vazio escolhe a que contém o objeto no início do Play.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Target

public Astra.ObjectReference Target { get; set; }

Seguir objeto. Persegue o objeto sem script; SetDestination substitui o alvo

Caminho: Inspector → Agente de navegação → Geral; ou fachada C# em um Behavior.

Uso: Seguir objeto: Objeto perseguido sem script. SetDestination substitui o alvo até Resume.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

TypeId

public static string TypeId { get; }

Caminho: Inspector → Agente de navegação; ou fachada C# em um Behavior.

Uso: Identificador nativo usado em AddComponent/GetComponent.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

UpdateRotation

public bool UpdateRotation { get; set; }

Girar para o movimento. Gira o objeto em Y para a direção da velocidade

Caminho: Inspector → Agente de navegação → Movimento; ou fachada C# em um Behavior.

Uso: Girar para o movimento: Gira o objeto em Y para a direção do movimento (Personagem e própria pose).

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

UseDifficult

public bool UseDifficult { get; set; }

Atravessar área difícil

Caminho: Inspector → Agente de navegação → Áreas; ou fachada C# em um Behavior.

Uso: Atravessar área difícil: Permite atravessar a área Difícil, com o custo configurado.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

UseJump

public bool UseJump { get; set; }

Usar links e áreas de salto

Caminho: Inspector → Agente de navegação → Áreas; ou fachada C# em um Behavior.

Uso: Usar links e áreas de salto: Permite usar links e áreas de Salto no caminho.

Roadmap deste membro: Câmera e navegação. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.