Astra.GuiAccess

Astra 0.2.3-preview.20261007Referência de assinaturasReferência revisada · 07 out. 2026

UI in this Play session. Preview/Play owns a copy of the authored .aeui.

Namespace: Astra · Assembly: Astra.Scripting · Tipo: Class

Declaração

class Astra.GuiAccess

UI in this Play session. Preview/Play owns a copy of the authored .aeui.

Onde acessar este tipo

Editor → Interface → documento .aeui; cena → objeto Canvas UI. Dentro de um Behavior, Gui.ForCanvas(owner) seleciona a instância, Find/TryFind localiza o elemento e Poll consome eventos. Gui é a propriedade protegida herdada de Behavior; use ForCanvas para escolher explicitamente o proprietário. HUD completo.

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

Membro	Categoria
.ctor	Method
Create	Method
Find	Method
ForCanvas	Method
Poll	Method
TryFind	Method
Canvas	Property
Diagnostic	Property
Input	Property
InstanceId	Property

.ctor

public GuiAccess(Astra.ISceneAccess scene)

UI in this Play session. Preview/Play owns a copy of the authored .aeui.

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em 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: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro	Tipo	Contrato
`scene`	`Astra.ISceneAccess`

Create

public Astra.GuiElement Create(Astra.GuiKind kind, Astra.GuiElement parent = default(Astra.GuiElement), string name = "")

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Cria elemento na cópia runtime da instância. GuiKind define o tipo; parent precisa pertencer ao mesmo contexto. Não grava a autoria .aeui.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro	Tipo	Contrato
`kind`	`Astra.GuiKind`
`parent`	`Astra.GuiElement`	· Opcional: ``
`name`	`string`	· Opcional: ``

Find

public Astra.GuiElement Find(string name)

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Busca nome exato e entrega handle desta instância; lança erro se ausente. Resolva em Start e conserve enquanto a instância estiver viva.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro	Tipo	Contrato
`name`	`string`

ForCanvas

public Astra.GuiAccess ForCanvas(Astra.GameObject owner, ulong componentInstance = 0)

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Escolhe a UI do objeto proprietário e, quando informado, a instância exata do componente. Não passa um GuiElement como proprietário.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro	Tipo	Contrato
`owner`	`Astra.GameObject`
`componentInstance`	`ulong`	· Opcional: `0`

Poll

public bool Poll(out Astra.GuiEvent message)

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Retira um evento da fila. Use while, filtre Kind e identifique Element. Mantenha um consumidor da fila por Canvas.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro	Tipo	Contrato
`message`	`Astra.GuiEvent`	· Out

TryFind

public bool TryFind(string name, out Astra.GuiElement element)

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Busca sem presumir sucesso; teste o bool antes de usar o out element. Útil quando o elemento é opcional.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro	Tipo	Contrato
`name`	`string`
`element`	`Astra.GuiElement`	· Out

Canvas

public Astra.GuiCanvas Canvas { get; set; }

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Apresentação da instância GUI; em cena, o componente UiCanvas é a origem da configuração. Não grava a fonte.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Diagnostic

public string Diagnostic { get; }

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Mensagem de diagnóstico da instância, útil para ação/alvo/pose inválidos. Não é um status global de todas as UI.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Input

public Astra.GuiInputAccess Input { get; }

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Estado bruto de gesto do controle (Value, Pressed, Pointer, Device). Não substitui ação do receptor.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

InstanceId

public ulong InstanceId { get; }

Caminho: Interface / Canvas UI → documento → elemento; use o contexto Gui.ForCanvas em Behavior.

Uso: Identidade da instância runtime; não salve uma lease como referência autoral.

Roadmap deste membro: Canvas e UI de jogo. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.