Pular para o conteúdo
AstraDOCS

Astra.Components.PlayerInput

Astra 0.4.0-preview.20261028Referência de assinaturas

Entrada do jogador: Ações do mapa de entrada viram eventos deste objeto. Família Lógica · Eventos.

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

readonly struct Astra.Components.PlayerInput

Entrada do jogador: Ações do mapa de entrada viram eventos deste objeto. Família Lógica · Eventos.

Referência estudada: https://docs.unity3d.com/Packages/com.unity.inputsystem@1.11/manual/PlayerInput.html

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

Hierarquia → selecione o objeto → Inspector → Adicionar componente → Lógica / Eventos → Entrada do jogador.

No Behavior em Play, obtenha a fachada com Object.GetComponent<PlayerInput>(); trate null antes de usar. Para outro objeto, resolva uma ObjectReference e consulte nesse objeto. Criar new PlayerInput(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 Entrada do jogador para propriedades, valores iniciais, requisitos e edição em Play.

Membro Categoria
.ctor Method
Canceled Method
OnCanceled Method
OnPerformed Method
Performed Method
Remove Method
Wrap Method
Actions Property
Component Property
Enabled Property
InstanceId Property
IsAlive Property
Object Property
TypeId Property

.ctor

public PlayerInput(Astra.Component component)

Caminho: Inspector → Entrada do jogador; 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

Canceled

public Astra.ComponentSubscription Canceled(Astra.Behavior owner, System.Action<int> handler)

PlayerInput › Invoke Unity Events › canceled.

Caminho: Inspector → Entrada do jogador; ou fachada C# em um Behavior.

Uso: PlayerInput › Invoke Unity Events › canceled.

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

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

OnCanceled

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

Ação cancelada. A ação foi solta neste quadro (canceled do Input System). Payload: Ação: inteiro

Caminho: Inspector → Entrada do jogador; ou fachada C# em um Behavior.

Uso: Ação cancelada. A ação foi solta neste quadro (canceled do Input System). Payload: Ação: inteiro

Roadmap deste membro: Objetos, Behaviors e composiçã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;

OnPerformed

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

Ação executada. A ação disparou neste quadro (performed do Input System); o valor é o índice da ação, a partir de 1. Payload: Ação: inteiro

Caminho: Inspector → Entrada do jogador; ou fachada C# em um Behavior.

Uso: Ação executada. A ação disparou neste quadro (performed do Input System); o valor é o índice da ação, a partir de 1. Payload: Ação: inteiro

Roadmap deste membro: Objetos, Behaviors e composiçã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;

Performed

public Astra.ComponentSubscription Performed(Astra.Behavior owner, System.Action<int> handler)

PlayerInput › Invoke Unity Events › performed: recebe o índice da ação no mapa (a partir de 1).

Caminho: Inspector → Entrada do jogador; ou fachada C# em um Behavior.

Uso: PlayerInput › Invoke Unity Events › performed: recebe o índice da ação no mapa (a partir de 1).

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

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

Remove

public void Remove()

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

Caminho: Inspector → Entrada do jogador; 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.PlayerInput Wrap(Astra.Component component)

Caminho: Inspector → Entrada do jogador; 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

Actions

public Astra.Components.PlayerInput.ActionsOption Actions { get; set; }

Ações. Ações do mapa de entrada da cena que geram eventos neste objeto

Caminho: Inspector → Entrada do jogador → Entrada; ou fachada C# em um Behavior.

Uso: Ações: Ações do mapa de entrada da cena que geram eventos neste objeto

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 → Entrada do jogador; 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.

Enabled

public bool Enabled { get; set; }

Ativa. Desligada não emite eventos; as ações continuam valendo para scripts e personagem

Caminho: Inspector → Entrada do jogador → Entrada; ou fachada C# em um Behavior.

Uso: Ativa: Desligada não emite eventos; as ações continuam valendo para scripts e personagem

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 → Entrada do jogador; 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 → Entrada do jogador; 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.

Object

public Astra.GameObject Object { get; }

Caminho: Inspector → Entrada do jogador; 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 → Entrada do jogador; 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.