Pular para o conteúdo
AstraDOCS

Astra.Components.Recoil

Astra 0.3.1-preview.20261016Referência de assinaturas

Recuo: Levanta e recua a cadeia a cada disparo. Família Lógica · IK.

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

readonly struct Astra.Components.Recoil

Recuo: Levanta e recua a cadeia a cada disparo. Família Lógica · IK.

Referência estudada: https://docs.unity3d.com/Packages/com.unity.animation.rigging@1.2/manual/constraints/MultiAimConstraint.html

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

Hierarquia → selecione o objeto → Inspector → Adicionar componente → Lógica / IK → Recuo.

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

Objetos, Behaviors e composiçã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 Recuo para propriedades, valores iniciais, requisitos e edição em Play.

Membro Categoria
.ctor Method
Fire Method
Remove Method
Wrap Method
Axis Property
ChainLength Property
Component Property
Duration Property
Enabled Property
InstanceId Property
IsAlive Property
KickAngle Property
KickBack Property
Object Property
TypeId Property
Weight Property

.ctor

public Recoil(Astra.Component component)

Caminho: Inspector → Recuo; 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
component Astra.Component

Fire

public void Fire(double magnitude)

Disparar. Aplica um recuo; intensidade 1 usa os valores autorados

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

Caminho: Inspector → Recuo; ou fachada C# em um Behavior.

Uso: Disparar. Aplica um recuo; intensidade 1 usa os valores autorados

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
magnitude double

Remove

public void Remove()

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

Caminho: Inspector → Recuo; ou fachada C# em um Behavior.

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

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Wrap

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

Caminho: Inspector → Recuo; ou fachada C# em um Behavior.

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

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
component Astra.Component

Axis

public Astra.Components.Recoil.AxisOption Axis { get; set; }

Eixo do cano

Caminho: Inspector → Recuo → Cadeia; ou fachada C# em um Behavior.

Uso: Eixo do cano: Eixo local do osso usado pelo efeito; os eixos variam por modelo (no Robot Kyle, o +Z da cabeça aponta para o lado). As receitas escolhem o eixo alinhado com a frente do personagem.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

ChainLength

public float ChainLength { get; set; }

Ossos no recuo (ossos)

Faixa válida: 1 a 8.

Caminho: Inspector → Recuo → Cadeia; ou fachada C# em um Behavior.

Uso: Ossos no recuo: Quantos ossos acima deste participam.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Component

public Astra.Component Component { get; }

Caminho: Inspector → Recuo; 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Duration

public float Duration { get; set; }

Recuperação (s)

Faixa válida: 0.02 a 3.

Caminho: Inspector → Recuo → Recuo; ou fachada C# em um Behavior.

Uso: Recuperação: Tempo para voltar.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Enabled

public bool Enabled { get; set; }

Ativo

Caminho: Inspector → Recuo → Influência; ou fachada C# em um Behavior.

Uso: Ativo: Desligado, o componente fica na cena sem agir.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

InstanceId

public ulong InstanceId { get; }

Caminho: Inspector → Recuo; ou fachada C# em um Behavior.

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

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

IsAlive

public bool IsAlive { get; }

Caminho: Inspector → Recuo; 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

KickAngle

public float KickAngle { get; set; }

Levantar (graus)

Faixa válida: 0 a 60.

Caminho: Inspector → Recuo → Recuo; ou fachada C# em um Behavior.

Uso: Levantar: Levantada do cano em graus.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

KickBack

public float KickBack { get; set; }

Recuar (m)

Faixa válida: 0 a 1.

Caminho: Inspector → Recuo → Recuo; ou fachada C# em um Behavior.

Uso: Recuar: Recuo da mão em metros.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Object

public Astra.GameObject Object { get; }

Caminho: Inspector → Recuo; ou fachada C# em um Behavior.

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

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

TypeId

public static string TypeId { get; }

Caminho: Inspector → Recuo; ou fachada C# em um Behavior.

Uso: Identificador nativo usado em AddComponent/GetComponent.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Weight

public float Weight { get; set; }

Peso

Faixa válida: 0 a 1.

Caminho: Inspector → Recuo → Influência; ou fachada C# em um Behavior.

Uso: Peso: 0 desliga, 1 aplica por inteiro; anime para ligar e desligar o efeito com suavidade.

Roadmap deste membro: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.