Pular para o conteúdo
AstraDOCS

Astra.Component

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

Uma instância de componente endereçada por objeto + instanceId. Componentes repetíveis (colisor, junta, comportamento) têm cada instância endereçável.

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

readonly struct Astra.Component

Uma instância de componente endereçada por objeto + instanceId. Componentes repetíveis (colisor, junta, comportamento) têm cada instância endereçável.

Crie/compile um Behavior na área de código e anexe ao objeto. Object, Scene e Scenes dão acesso ao mundo da sessão. Referências autorais são resolvidas com Resolve; handles do Play anterior não são reutilizados.

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.

Membro Categoria
Animation Method
CameraFollow Method
Curve Method
DeformableMesh Method
FollowPath Method
GetBool Method
GetEnum Method
GetFloat Method
GetReference Method
GetResource Method
GetResourceByElementId Method
GetSlotEnum Method
GetSlotFloat Method
Invoke Method
Invoke Method
Material Method
Remove Method
RemoveTracked Method
ResourceElementId Method
SetBool Method
SetEnum Method
SetFloat Method
SetReference Method
SetReference Method
SetResource Method
SetResourceByElementId Method
SetSlotEnum Method
SetSlotFloat Method
SetVector2 Method
SetVector3 Method
Timer Method
ToString Method
Enabled Property
InstanceId Property
IsAlive Property
Object Property
TypeId Property

Animation

public Astra.AnimationPlayer Animation()

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

CameraFollow

public Astra.CameraFollowRig CameraFollow()

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

Curve

public Astra.CurvePath Curve()

Stable point identities, Bézier handles and world distance sampling.

Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.

Uso: Stable point identities, Bézier handles and world distance sampling.

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

DeformableMesh

public Astra.DeformableMesh DeformableMesh()

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

FollowPath

public Astra.PathFollower FollowPath()

Control the real path follower in the current Play world.

Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.

Uso: Control the real path follower in the current Play world.

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

GetBool

public bool GetBool(string propertyId)

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

Parâmetro Tipo Contrato
propertyId string

GetEnum

public uint GetEnum(string propertyId)

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

Parâmetro Tipo Contrato
propertyId string

GetFloat

public float GetFloat(string propertyId)

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

Parâmetro Tipo Contrato
propertyId string

GetReference

public Astra.ObjectReference GetReference(string propertyId)

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

Parâmetro Tipo Contrato
propertyId string

GetResource

public Astra.AssetGuid GetResource(string propertyId, uint slot = 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
propertyId string
slot uint · Opcional: 0

GetResourceByElementId

public Astra.AssetGuid GetResourceByElementId(string propertyId, ulong elementId)

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

Parâmetro Tipo Contrato
propertyId string
elementId ulong

GetSlotEnum

public uint GetSlotEnum(string propertyId, uint slot = 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
propertyId string
slot uint · Opcional: 0

GetSlotFloat

public float GetSlotFloat(string propertyId, uint slot = 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
propertyId string
slot uint · Opcional: 0

Invoke

public Astra.ComponentValue Invoke(string method, params Astra.ComponentValue[] arguments)

Executa um método declarado pelo tipo do componente no mundo de Play, com os argumentos tipados do descritor nativo. Host sem a família astra.component.operations lança System.NotSupportedException.

Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.

Uso: Executa um método declarado pelo tipo do componente no mundo de Play, com os argumentos tipados do descritor nativo. Host sem a família astra.component.operations lança System.NotSupportedException.

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

Parâmetro Tipo Contrato
method string
arguments Astra.ComponentValue[]

Invoke

public Astra.ComponentValue Invoke(string method, System.ReadOnlySpan<Astra.ComponentValue> arguments)

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

Parâmetro Tipo Contrato
method string
arguments System.ReadOnlySpan&lt;Astra.ComponentValue&gt;

Material

public Astra.MaterialSlot Material(uint slot = 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
slot uint · Opcional: 0

Remove

public void Remove()

Remoção aplicada no próximo ponto seguro do mundo.

Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.

Uso: Remoção aplicada no próximo ponto seguro do mundo.

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

RemoveTracked

public Astra.WorldOperation RemoveTracked()

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

ResourceElementId

public ulong ResourceElementId(string propertyId, uint slot)

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

Parâmetro Tipo Contrato
propertyId string
slot uint

SetBool

public void SetBool(string propertyId, bool value)

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

Parâmetro Tipo Contrato
propertyId string
value bool

SetEnum

public void SetEnum(string propertyId, uint value)

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

Parâmetro Tipo Contrato
propertyId string
value uint

SetFloat

public void SetFloat(string propertyId, float value)

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

Parâmetro Tipo Contrato
propertyId string
value float

SetReference

public void SetReference(string propertyId, Astra.GameObject? value)

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

Parâmetro Tipo Contrato
propertyId string
value Astra.GameObject?

SetReference

public void SetReference(string propertyId, Astra.ObjectReference value)

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

Parâmetro Tipo Contrato
propertyId string
value Astra.ObjectReference

SetResource

public void SetResource(string propertyId, Astra.AssetGuid value, uint slot = 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
propertyId string
value Astra.AssetGuid
slot uint · Opcional: 0

SetResourceByElementId

public void SetResourceByElementId(string propertyId, ulong elementId, Astra.AssetGuid value)

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

Parâmetro Tipo Contrato
propertyId string
elementId ulong
value Astra.AssetGuid

SetSlotEnum

public void SetSlotEnum(string propertyId, uint value, uint slot = 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
propertyId string
value uint
slot uint · Opcional: 0

SetSlotFloat

public void SetSlotFloat(string propertyId, float value, uint slot = 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

Parâmetro Tipo Contrato
propertyId string
value float
slot uint · Opcional: 0

SetVector2

public void SetVector2(string propertyId, System.Numerics.Vector2 value)

Writes the two persisted channels atomically; transport padding is zero.

Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.

Uso: Writes the two persisted channels atomically; transport padding is zero.

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

Parâmetro Tipo Contrato
propertyId string
value System.Numerics.Vector2

SetVector3

public void SetVector3(string propertyId, System.Numerics.Vector3 value)

Valida e publica os três canais refletidos como uma única atribuição.

Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.

Uso: Valida e publica os três canais refletidos como uma única atribuição.

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

Parâmetro Tipo Contrato
propertyId string
value System.Numerics.Vector3

Timer

public Astra.Components.GameTimer Timer()

Fachada gerada do schema (Astra.Components.GameTimer).

Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.

Uso: Fachada gerada do schema (Astra.Components.GameTimer).

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

ToString

public override string ToString()

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

Enabled

public bool Enabled { get; set; }

Estado local dos tipos que declaram a propriedade enabled no schema. Tipos sem essa capacidade recusam a operação; não desativa o objeto.

Caminho: Área de código → Behavior compilado/anexado → acesso descrito em “Onde acessar este tipo”.

Uso: Estado local dos tipos que declaram a propriedade enabled no schema. Tipos sem essa capacidade recusam a operação; não desativa o objeto.

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

IsAlive

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

Object

public Astra.GameObject Object { 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: Objetos, Behaviors e composição. Contrato existente neste snapshot; sem tarefa individual/datada registrada nesta referência.

TypeId

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