Astra.Components.ShapeCast
Varredura de forma: Varre uma forma até o alvo e guarda o primeiro acerto. Família Física 3D · Consultas.
Namespace: Astra.Components · Assembly: Astra.Scripting · Tipo: Struct
Declaração
Seção intitulada “Declaração”readonly struct Astra.Components.ShapeCastVarredura de forma: Varre uma forma até o alvo e guarda o primeiro acerto. Família Física 3D · Consultas.
Referência estudada: https://docs.godotengine.org/en/4.5/classes/class_shapecast3d.html
Interfaces: Astra.Components.IComponentFacade<Astra.Components.ShapeCast>.
Onde acessar este tipo
Seção intitulada “Onde acessar este tipo”Hierarquia → selecione o objeto → Inspector → Adicionar componente → Física 3D / Consultas → Varredura de forma.
No Behavior em Play, obtenha a fachada com Object.GetComponent<ShapeCast>(); trate null antes de usar. Para outro objeto, resolva uma ObjectReference e consulte nesse objeto. Criar new ShapeCast(component) envolve um componente existente; não adiciona um componente à cena.
Roadmap e uso
Seção intitulada “Roadmap e uso”Física 3D e motores: 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 Varredura de forma para propriedades, valores iniciais, requisitos e edição em Play.
Membros
Seção intitulada “Membros”| Membro | Categoria |
|---|---|
| .ctor | Method |
| Collider | Method |
| Colliding | Method |
| Distance | Method |
| Normal | Method |
| Point | Method |
| Remove | Method |
| Update | Method |
| Wrap | Method |
| Component | Property |
| Enabled | Property |
| ExcludeSelf | Property |
| HalfExtents | Property |
| HalfHeight | Property |
| IncludeDynamic | Property |
| IncludeSensors | Property |
| IncludeStatic | Property |
| InstanceId | Property |
| IsAlive | Property |
| Layer | Property |
| Object | Property |
| Radius | Property |
| Shape | Property |
| Target | Property |
| TypeId | Property |
.ctor
public ShapeCast(Astra.Component component)Caminho: Inspector → Varredura de forma; 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: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
component |
Astra.Component |
Collider
public Astra.ObjectReference Collider()Objeto atingido. Dono do corpo atingido; vazio sem acerto
Executado no mundo de Play; fora dele lança WorldException NotRunning.
Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Objeto atingido. Dono do corpo atingido; vazio sem acerto
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Colliding
public bool Colliding()Acertando. Verdadeiro quando a última consulta encontrou algo
Executado no mundo de Play; fora dele lança WorldException NotRunning.
Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Acertando. Verdadeiro quando a última consulta encontrou algo
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Distance
public double Distance()Distância. Distância do acerto ao início, em metros
Executado no mundo de Play; fora dele lança WorldException NotRunning.
Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Distância. Distância do acerto ao início, em metros
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Normal
public System.Numerics.Vector3 Normal()Normal. Normal da superfície atingida
Executado no mundo de Play; fora dele lança WorldException NotRunning.
Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Normal. Normal da superfície atingida
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Point
public System.Numerics.Vector3 Point()Ponto. Ponto do acerto no mundo
Executado no mundo de Play; fora dele lança WorldException NotRunning.
Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Ponto. Ponto do acerto no mundo
Roadmap deste membro: Física 3D e motores. 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 → Varredura de forma; ou fachada C# em um Behavior.
Uso: Solicita remoção pelo lifecycle nativo; dependências e regras de Play podem recusar.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Update
public void Update()Atualizar agora. Refaz a consulta neste instante (force_raycast_update do Godot)
Executado no mundo de Play; fora dele lança WorldException NotRunning.
Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Atualizar agora. Refaz a consulta neste instante (force_raycast_update do Godot)
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Wrap
public static Astra.Components.ShapeCast Wrap(Astra.Component component)Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Envolve um Component existente após conferir TypeId; não cria componente.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
component |
Astra.Component |
Component
public Astra.Component Component { get; }Caminho: Inspector → Varredura de forma; 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: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Enabled
public bool Enabled { get; set; }Ativo. Desligado não consulta e mantém o último resultado como vazio
Caminho: Inspector → Varredura de forma → Consulta; ou fachada C# em um Behavior.
Uso: Ativo: Desligado não consulta e mantém o último resultado como vazio
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
ExcludeSelf
public bool ExcludeSelf { get; set; }Ignorar o próprio corpo. Ignora o corpo deste objeto ou do ancestral mais próximo com Corpo físico
Caminho: Inspector → Varredura de forma → Filtro; ou fachada C# em um Behavior.
Uso: Ignorar o próprio corpo: Exclui o primeiro Corpo físico encontrado neste objeto ou subindo por seus ancestrais. Use para não atingir o jogador que sustenta a consulta; sem esse corpo ancestral, não há exclusão automática de todos os colliders do ramo.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
HalfExtents
public System.Numerics.Vector3 HalfExtents { get; set; }Meia extensão
Caminho: Inspector → Varredura de forma → Forma; ou fachada C# em um Behavior.
Uso: Meia extensão X: Meia extensão da caixa neste eixo, em metros. Uma extensão .5 representa tamanho total 1 nesse eixo. Meia extensão Y: Meia extensão da caixa neste eixo, em metros. Uma extensão .5 representa tamanho total 1 nesse eixo. Meia extensão Z: Meia extensão da caixa neste eixo, em metros. Uma extensão .5 representa tamanho total 1 nesse eixo.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
HalfHeight
public float HalfHeight { get; set; }Meia altura (m)
Faixa válida: 0.001 a 1000.
Caminho: Inspector → Varredura de forma → Forma; ou fachada C# em um Behavior.
Uso: Meia altura: Meia altura do volume em metros, para cápsula/cilindro conforme Forma. Não é a altura inteira de um modelo.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
IncludeDynamic
public bool IncludeDynamic { get; set; }Incluir dinâmicos
Caminho: Inspector → Varredura de forma → Filtro; ou fachada C# em um Behavior.
Uso: Incluir dinâmicos: Inclui corpos dinâmicos no resultado; não aplica força nem impede movimento por conta própria.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
IncludeSensors
public bool IncludeSensors { get; set; }Incluir sensores. Sensores ficam de fora por padrão (collide_with_areas do Godot)
Caminho: Inspector → Varredura de forma → Filtro; ou fachada C# em um Behavior.
Uso: Incluir sensores: Inclui formas sensoras no resultado. Desligado evita tratar volumes de trigger como paredes.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
IncludeStatic
public bool IncludeStatic { get; set; }Incluir estáticos
Caminho: Inspector → Varredura de forma → Filtro; ou fachada C# em um Behavior.
Uso: Incluir estáticos: Inclui corpos estáticos, como chão e paredes. Desligar pode explicar ausência de acerto.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
InstanceId
public ulong InstanceId { get; }Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Distingue a instância no mesmo objeto; importante para componentes múltiplos.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
IsAlive
public bool IsAlive { get; }Caminho: Inspector → Varredura de forma; 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: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Layer
public Astra.Components.ShapeCast.LayerOption Layer { get; set; }Camada. Todas ou só uma camada física do projeto
Caminho: Inspector → Varredura de forma → Filtro; ou fachada C# em um Behavior.
Uso: Camada: Todas aceita camadas do projeto; escolher uma limita a consulta. A camada da malha visual não cria forma física.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Object
public Astra.GameObject Object { get; }Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Objeto dono deste componente; use para resolver composição.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Radius
public float Radius { get; set; }Raio (m)
Faixa válida: 0.001 a 1000.
Caminho: Inspector → Varredura de forma → Forma; ou fachada C# em um Behavior.
Uso: Raio: Raio em metros da esfera/cápsula, visível conforme Forma. Não é comprimento do segmento.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Shape
public Astra.Components.ShapeCast.ShapeOption Shape { get; set; }Forma
Caminho: Inspector → Varredura de forma → Forma; ou fachada C# em um Behavior.
Uso: Forma: Escolhe Esfera, Caixa, Cápsula ou Cilindro para a varredura. Configure somente as dimensões relevantes da forma; isso não cria um collider persistente.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Target
public System.Numerics.Vector3 Target { get; set; }Alvo local
Caminho: Inspector → Varredura de forma → Consulta; ou fachada C# em um Behavior.
Uso: Alvo X: Componente do vetor local do segmento em metros. Seu módulo define alcance; girar o objeto gira a direção em mundo. Não é uma posição absoluta do alvo. Alvo Y: Componente do vetor local do segmento em metros. Seu módulo define alcance; girar o objeto gira a direção em mundo. Não é uma posição absoluta do alvo. Alvo Z: Componente do vetor local do segmento em metros. Seu módulo define alcance; girar o objeto gira a direção em mundo. Não é uma posição absoluta do alvo.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
TypeId
public static string TypeId { get; }Caminho: Inspector → Varredura de forma; ou fachada C# em um Behavior.
Uso: Identificador nativo usado em AddComponent/GetComponent.
Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.