Astra.InputAccess
As ações de entrada vistas pelo projeto. O núcleo não conhece "Mover" nem "Saltar": quem nomeia as ações, escolhe o que as aciona e diz quais papéis elas cumprem é o projeto, no recurso de ações. Um comportamento que queira "a ação de andar deste jogo, seja qual for o nome" pergunta por Astra.InputAccess.RoleAction(Astra.InputRole). Quando a interface do editor está com o toque (IDE aberta, teclado, modal, gizmo arrastado) o gameplay perde o foco: todos os eixos leem zero e nenhum botão fica preso.
Namespace: Astra · Assembly: Astra.Scripting · Tipo: Struct
Declaração
Seção intitulada “Declaração”readonly struct Astra.InputAccessAs ações de entrada vistas pelo projeto. O núcleo não conhece “Mover” nem “Saltar”: quem nomeia as ações, escolhe o que as aciona e diz quais papéis elas cumprem é o projeto, no recurso de ações. Um comportamento que queira “a ação de andar deste jogo, seja qual for o nome” pergunta por Astra.InputAccess.RoleAction(Astra.InputRole). Quando a interface do editor está com o toque (IDE aberta, teclado, modal, gizmo arrastado) o gameplay perde o foco: todos os eixos leem zero e nenhum botão fica preso.
Onde acessar este tipo
Seção intitulada “Onde acessar este tipo”Configure ações do projeto e, no Behavior, use Input ou Haptics. Controles do Canvas leem o receptor pelo contexto Gui.ForCanvas; não confunda ação de entrada com evento de GUI.
Roadmap e uso
Seção intitulada “Roadmap e uso”Canvas e UI de jogo: 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.
Membros
Seção intitulada “Membros”| Membro | Categoria |
|---|---|
| .ctor | Method |
| ActionState | Method |
| ApplyBindingOverride | Method |
| Axis | Method |
| Axis2 | Method |
| BeginBindingCapture | Method |
| CancelBindingCapture | Method |
| ContextEnabled | Method |
| Exists | Method |
| ExportProfile | Method |
| GetBinding | Method |
| ImportProfile | Method |
| JustPressed | Method |
| JustReleased | Method |
| LoadProfile | Method |
| Pressed | Method |
| RemoveAllBindingOverrides | Method |
| RemoveBindingOverride | Method |
| RestoreActionEnabled | Method |
| RoleAction | Method |
| SaveProfile | Method |
| SetActionEnabled | Method |
| SetContextEnabled | Method |
| BindingCaptureStatus | Property |
| DeviceGroups | Property |
| JumpPressed | Property |
| Look | Property |
| Move | Property |
.ctor
public InputAccess(Astra.ISceneAccess scene)As ações de entrada vistas pelo projeto. O núcleo não conhece “Mover” nem “Saltar”: quem nomeia as ações, escolhe o que as aciona e diz quais papéis elas cumprem é o projeto, no recurso de ações. Um comportamento que queira “a ação de andar deste jogo, seja qual for o nome” pergunta por Astra.InputAccess.RoleAction(Astra.InputRole). Quando a interface do editor está com o toque (IDE aberta, teclado, modal, gizmo arrastado) o gameplay perde o foco: todos os eixos leem zero e nenhum botão fica preso.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
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: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
scene |
Astra.ISceneAccess |
ActionState
public Astra.InputActionState ActionState(string action)State of the real interaction. Timing uses unscaled sampled input time.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: State of the real interaction. Timing uses unscaled sampled input time.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
ApplyBindingOverride
public bool ApplyBindingOverride(string action, uint index, Astra.InputBindingValue binding)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
|
index |
uint |
|
binding |
Astra.InputBindingValue |
Axis
public float Axis(string action)Componente X do eixo, para ações Axis1D.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Componente X do eixo, para ações Axis1D.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
Axis2
public System.Numerics.Vector2 Axis2(string action)Eixo 2D da ação. Ação desconhecida lê zero.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Eixo 2D da ação. Ação desconhecida lê zero.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
BeginBindingCapture
public bool BeginBindingCapture(string action, uint index, Astra.InputSource source, bool negative = false, uint cancelKey = 111)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
|
index |
uint |
|
source |
Astra.InputSource |
|
negative |
bool |
· Opcional: False |
cancelKey |
uint |
· Opcional: 111 |
CancelBindingCapture
public void CancelBindingCapture()Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
ContextEnabled
public bool ContextEnabled(string context)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
context |
string |
Exists
public bool Exists(string action)Falso quando a ação nem existe no mapa do projeto.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Falso quando a ação nem existe no mapa do projeto.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
ExportProfile
public string ExportProfile()Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
GetBinding
public Astra.InputBindingValue GetBinding(string action, uint index = 0, bool authored = false)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
|
index |
uint |
· Opcional: 0 |
authored |
bool |
· Opcional: False |
ImportProfile
public bool ImportProfile(string profile)Troca todos os overrides atomicamente; mapa incompatível é recusado sem alteração.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Troca todos os overrides atomicamente; mapa incompatível é recusado sem alteração.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
profile |
string |
JustPressed
public bool JustPressed(string action)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
JustReleased
public bool JustReleased(string action)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
LoadProfile
public bool LoadProfile(string path)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
path |
string |
Pressed
public bool Pressed(string action)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
RemoveAllBindingOverrides
public void RemoveAllBindingOverrides()Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
RemoveBindingOverride
public bool RemoveBindingOverride(string action, uint index = 0)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
|
index |
uint |
· Opcional: 0 |
RestoreActionEnabled
public bool RestoreActionEnabled(string action)Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Chame pelo acesso deste tipo indicado acima, com argumentos da assinatura. O efeito especializado deste membro ainda precisa de revisão editorial individual; não deduza equivalência com Unity/Godot pelo nome.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
RoleAction
public string RoleAction(Astra.InputRole role)Nome da ação que o projeto atribuiu a este papel, ou vazio.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Nome da ação que o projeto atribuiu a este papel, ou vazio.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
role |
Astra.InputRole |
SaveProfile
public void SaveProfile(string path)Grava o perfil separado da cena. O jogo escolhe o caminho de armazenamento do jogador.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Grava o perfil separado da cena. O jogo escolhe o caminho de armazenamento do jogador.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
path |
string |
SetActionEnabled
public bool SetActionEnabled(string action, bool enabled)Runtime policy only; the scene and rebind profile remain authored data.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Runtime policy only; the scene and rebind profile remain authored data.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
action |
string |
|
enabled |
bool |
SetContextEnabled
public void SetContextEnabled(string context, bool enabled)Liga ou desliga um contexto. Uma ação em contexto desligado lê zero sem perder o que o usuário configurou — é assim que um menu do jogo silencia o controle do personagem sem apagar o mapa.
Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Liga ou desliga um contexto. Uma ação em contexto desligado lê zero sem perder o que o usuário configurou — é assim que um menu do jogo silencia o controle do personagem sem apagar o mapa.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
| Parâmetro | Tipo | Contrato |
|---|---|---|
context |
string |
|
enabled |
bool |
BindingCaptureStatus
public Astra.InputCaptureStatus BindingCaptureStatus { get; }Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Campo/propriedade conforme a declaração. Confira get/set/init e o tipo; a interpretação especializada ainda não tem revisão editorial individual neste snapshot.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
DeviceGroups
public Astra.InputDeviceGroups DeviceGroups { get; set; }Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Campo/propriedade conforme a declaração. Confira get/set/init e o tipo; a interpretação especializada ainda não tem revisão editorial individual neste snapshot.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
JumpPressed
public bool JumpPressed { get; }Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Campo/propriedade conforme a declaração. Confira get/set/init e o tipo; a interpretação especializada ainda não tem revisão editorial individual neste snapshot.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Look
public System.Numerics.Vector2 Look { get; }Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Campo/propriedade conforme a declaração. Confira get/set/init e o tipo; a interpretação especializada ainda não tem revisão editorial individual neste snapshot.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.
Move
public System.Numerics.Vector2 Move { get; }Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.
Uso: Campo/propriedade conforme a declaração. Confira get/set/init e o tipo; a interpretação especializada ainda não tem revisão editorial individual neste snapshot.
Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.