Astra.GuiElement

Namespace: Astra · 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.GuiElement

Stable ID and world identity; removed nodes and previous Play handles are rejected.

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. GuiElement vem de Find/TryFind/Create; um valor default não é um elemento válido. 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
AddAction	Method
MoveAction	Method
MoveEarlier	Method
MoveLater	Method
OnClick	Method
PlayAnimation	Method
Remove	Method
RemoveAction	Method
ReplaceAction	Method
SetText	Method
StopAnimation	Method
Actions	Property
Animation	Property
BaseImage	Property
ControlSettings	Property
Enabled	Property
Id	Property
Image	Property
ImageStyle	Property
Input	Property
InputAction	Property
InstanceId	Property
Interaction	Property
Kind	Property
KnobImage	Property
Layout	Property
Name	Property
Sizing	Property
Snapshot	Property
Style	Property
Text	Property
Transitions	Property
Value	Property
Visible	Property

AddAction

public void AddAction(Astra.GuiEventKind @event, Astra.GuiClickAction action, Astra.GuiElement target = default(Astra.GuiElement), float value = 0)

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

Uso: Acrescenta listener ordenado após ação principal, no mesmo documento. Até 16 ações por elemento no formato atual.

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

Parâmetro	Tipo	Contrato
event	Astra.GuiEventKind
action	Astra.GuiClickAction
target	Astra.GuiElement	· Opcional: ``
value	float	· Opcional: 0

MoveAction

public void MoveAction(int index, int destination)

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

Uso: Reordena listeners; ordem altera a sequência dos efeitos.

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

Parâmetro	Tipo	Contrato
index	int
destination	int

MoveEarlier

public void MoveEarlier()

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

Uso: Reordena o elemento na árvore runtime para posição anterior; observe desenho/hit/layout.

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

MoveLater

public void MoveLater()

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

Uso: Reordena o elemento na árvore runtime para posição posterior; observe desenho/hit/layout.

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

OnClick

public void OnClick(Astra.GuiClickAction action, Astra.GuiElement target = default(Astra.GuiElement), float value = 0)

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

Uso: Configura ação principal de clique e alvo da mesma instância; Notify permite consumir Poll. Para Image, o clique é 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
action	Astra.GuiClickAction
target	Astra.GuiElement	· Opcional: ``
value	float	· Opcional: 0

PlayAnimation

public void PlayAnimation()

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

Uso: Reinicia a transição configurada; precisa de animação habilitada válida.

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

Remove

public void Remove()

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

Uso: Remove nó e subárvore da cópia runtime, invalida handles/ações afetados. Não remove o componente Canvas da cena.

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

RemoveAction

public void RemoveAction(int index)

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

Uso: Remove listener no índice indicado, preservando os demais.

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

Parâmetro	Tipo	Contrato
index	int

ReplaceAction

public void ReplaceAction(int index, Astra.GuiActionBinding binding)

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

Uso: Troca listener no índice indicado; preserve evento, alvo e argumento válidos.

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

Parâmetro	Tipo	Contrato
index	int
binding	Astra.GuiActionBinding

SetText

public void SetText(string text)

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

Uso: Altera string do elemento runtime; Image não desenha texto.

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

Parâmetro	Tipo	Contrato
text	string

StopAnimation

public void StopAnimation()

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

Uso: Para e restaura pose autoral. Não é pause/resume da transição.

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

Actions

public Astra.GuiActionBinding[] Actions { get; }

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

Uso: Snapshot dos listeners adicionais; alterar o array retornado não substitui a lista no documento.

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

Animation

public Astra.GuiAnimation Animation { get; set; }

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

Uso: Configuração de uma transição de duas poses; enabled/autoplay/loop e delay são campos distintos.

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

BaseImage

public string BaseImage { get; set; }

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

Uso: Imagem de base do Joystick no projeto.

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

ControlSettings

public Astra.GuiControlSettings ControlSettings { get; set; }

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

Uso: Modo/eixo/gate, raios, zonas mortas, resposta e visual do controle touch.

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

Enabled

public bool Enabled { get; set; }

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

Uso: Participação em input/estado desabilitado; pode continuar desenhado. Ancestrais também influenciam.

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

Id

public uint Id { get; }

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

Uso: Identificador local do nó, não identidade global entre documentos/Canvas.

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

Image

public string Image { get; set; }

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

Uso: Caminho relativo de imagem dentro do projeto. Troca o recurso do elemento Image; não aceita URL/caminho externo.

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

ImageStyle

public Astra.GuiImageStyle ImageStyle { get; set; }

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

Uso: Fit e Tint da Image. Use with para conservar o outro campo. Conter preserva proporção e cabe inteira.

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

Input

public Astra.GuiControlSnapshot 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.

InputAction

public string InputAction { get; set; }

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

Uso: Nome da ação compatível do catálogo do projeto. Não é GuiClickAction.

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.

Interaction

public Astra.GuiInteraction Interaction { get; set; }

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

Uso: Clicável, ação, alvo e argumento do clique; alvo 0 significa o próprio elemento.

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

Kind

public Astra.GuiKind Kind { get; }

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

Uso: Tipo do elemento encontrado. Confira GuiKind.Image antes de tratar o nó como coração.

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

KnobImage

public string KnobImage { get; set; }

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

Uso: Imagem de puxador do Joystick no projeto.

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

Layout

public Astra.GuiLayout Layout { get; set; }

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

Uso: Âncoras normalizadas e bordas em pixels do pai. Offsets são esquerda/topo/direita/base, não largura/altura.

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

Name

public string Name { get; set; }

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

Uso: Nome exato usado por Find. ID e lease conservam identidade; renomear não converte outro handle.

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

Sizing

public Astra.GuiSizing Sizing { get; set; }

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

Uso: Tamanhos mínimo/preferido, pesos e espaçamento do layout automático. Pai HBox/VBox/Grid pode controlar o retângulo.

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

Snapshot

public Astra.GuiSnapshot Snapshot { get; }

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

Uso: Estado atual de tipo, visible/enabled e intervalo/valor, no contexto desta instância.

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

Style

public Astra.GuiStyle Style { get; set; }

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

Uso: Fundo, conteúdo, destaque, clipping, fonte e raio. Cores usam 0xAARRGGBB; preserve campos com with.

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

Text

public string Text { get; set; }

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

Uso: Lê/escreve conteúdo textual. Atualize o Text de status quando a vida mudar.

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

Transitions

public Astra.GuiTransitions Transitions { get; set; }

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

Uso: Configura estados Normal, Pressionado e Desabilitado; combina pose/tinta com a animação.

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

Value

public float Value { get; set; }

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

Uso: Escrita numérica para Toggle, Slider e Progress. Não altera vida nem preenchimento de Image.

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

Visible

public bool Visible { get; set; }

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

Uso: Liga/desliga a apresentação da subárvore. No HUD, esconde camada cheia e mantém a imagem vazia atrás.

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