Astra.Components.SpringArm

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

Sobre esta referência

Assinaturas extraídas semanticamente com Roslyn/MSBuild. Isso confirma a superfície do código deste snapshot; não comprova execução no Android. As descrições vêm dos comentários da API. Membros sem explicação ainda exigem revisão editorial.

Declaração

readonly struct Astra.Components.SpringArm

Braço de mola: Afasta os filhos até a primeira colisão, como câmera em terceira pessoa. Família Física 3D · Consultas.

Referência estudada: https://docs.godotengine.org/en/4.5/classes/class_springarm3d.html

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

Onde acessar este tipo

Hierarquia → selecione o objeto → Inspector → Adicionar componente → Física 3D / Consultas → Braço de mola.

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

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 Braço de mola para propriedades, valores iniciais, requisitos e edição em Play.

Membros

Membro	Categoria
.ctor	Method
HitLength	Method
Remove	Method
Wrap	Method
Component	Property
Enabled	Property
ExcludeSelf	Property
IncludeDynamic	Property
IncludeSensors	Property
IncludeStatic	Property
InstanceId	Property
IsAlive	Property
Layer	Property
Length	Property
Margin	Property
Object	Property
Radius	Property
TypeId	Property

.ctor

public SpringArm(Astra.Component component)

Caminho: Inspector → Braço de mola; 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

HitLength

public double HitLength()

Comprimento atual. Distância livre do último quadro, já descontada a margem

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

Caminho: Inspector → Braço de mola; ou fachada C# em um Behavior.

Uso: Comprimento atual. Distância livre do último quadro, já descontada a margem

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 → Braço de mola; 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.

Wrap

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

Caminho: Inspector → Braço de mola; 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 → Braço de mola; 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 → Braço de mola → 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 → Braço de mola → 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.

IncludeDynamic

public bool IncludeDynamic { get; set; }

Incluir dinâmicos

Caminho: Inspector → Braço de mola → 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 → Braço de mola → 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 → Braço de mola → 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 → Braço de mola; 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 → Braço de mola; 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.SpringArm.LayerOption Layer { get; set; }

Camada. Todas ou só uma camada física do projeto

Caminho: Inspector → Braço de mola → 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.

Length

public float Length { get; set; }

Comprimento (m). Distância livre máxima ao longo de +Z local

Faixa válida: 0.001 a 1000.

Caminho: Inspector → Braço de mola → Braço; ou fachada C# em um Behavior.

Uso: Comprimento: Comprimento desejado em metros no eixo +Z local. Obstáculos reduzem a distância efetiva dos filhos.

Roadmap deste membro: Física 3D e motores. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Margin

public float Margin { get; set; }

Margem (m). Folga entre o filho e a superfície atingida

Faixa válida: 0 a 10.

Caminho: Inspector → Braço de mola → Braço; ou fachada C# em um Behavior.

Uso: Margem: Margem em metros descontada no acerto, para conservar afastamento do obstáculo.

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 → Braço de mola; 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 da esfera (m). Zero usa raio de luz; maior varre uma esfera (evita a câmera atravessar quinas)

Faixa válida: 0 a 100.

Caminho: Inspector → Braço de mola → Braço; ou fachada C# em um Behavior.

Uso: Raio da esfera: Raio em metros do volume varrido. Zero usa linha; maior considera um volume esférico e ajuda em quinas.

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 → Braço de mola; 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.