Anotaciones
@editable mut velocidad : float = 5.01 · Una variable en el inspectorUna **anotación** empieza por @ y va delante de una declaración. @editable muestra la variable en el inspector del actor.
fn _ready() void {
print(velocidad)
}5.0
@editable mut velocidad : float = 5.0
fn _ready() void {
print(velocidad)2 · El inspector mandaEn esta escena, el inspector del actor tiene velocidad a 8. El código es el mismo, pero el valor ya no es el de por defecto.}8.0
@options("Fácil", "Normal", "Difícil") mut dificultad : int = 13 · Un desplegable@options muestra un desplegable con esas opciones. El valor es la posición de la elegida, empezando en 0: 1 es "Normal".
fn _ready() void {
print(dificultad)
}1
use actor::Jugador as jugador : Spatial2D
@onready mut inicio : Vector2 = jugador.position4 · Esperar al actor: @onready@onready da el valor a la variable cuando el actor ya está listo, justo antes de _ready. Sin ella, jugador todavía no se encontraría.
fn _ready() void {
print(inicio)
}(10.0, 20.0)
Ya has visto alguna palabra que empieza por @, como @persistent en la lección de guardar
partida. Son anotaciones: van delante de una declaración y no cambian lo que hace el código.
Le dicen algo al editor o al motor: “muestra esto en el inspector”, “dale valor a esto cuando el
actor esté listo”, “guarda esto”.
En esta lección ves las que más vas a usar.
@editable: valores en el inspector
Tienes un prefab de enemigo y quieres uno lento y otro rápido, sin escribir dos scripts. Marca la
velocidad con @editable:
module Enemigo
@editable mut velocidad : float = 5.0
fn _ready() void { print(velocidad)}La variable aparece en el inspector del actor, el panel donde ves y cambias sus propiedades.
El valor del código es el de por defecto: cada actor que usa el script puede cambiarlo en el
inspector sin tocar el código. Este es el mismo script en un actor que, en el inspector, tiene
velocidad a 8:
module Enemigo
@editable mut velocidad : float = 5.0
fn _ready() void { print(velocidad)}- Declárala con
mut: el inspector la cambia. - Su tipo decide el control del inspector: un campo numérico, una casilla para un
bool, un selector para unColor…
module Enemigo
@export mut velocidad : float = 5.0
fn _ready() void { print(velocidad)}Pistas para el inspector
Hay variantes de @editable que muestran un control más cómodo. Todas hacen la variable
editable, igual que @editable:
module Ajustes
@range(0, 100, 1) mut volumen : int = 50@options("Fácil", "Normal", "Difícil") mut dificultad : int = 1@multiline mut descripcion : String = "Un slime verde"@no_alpha mut tinte : Color = Color.WHITE
fn _ready() void { print(volumen) print(dificultad) print(descripcion)}| Anotación | Muestra |
|---|---|
@range(mín, máx, paso) | Un deslizador entre esos dos números |
@options("A", "B", ...) | Un desplegable; el valor es la posición de la opción (int) |
@multiline | Un cuadro de texto grande |
@no_alpha | Un selector de color sin transparencia |
@file("*.json") | Un selector de archivo; el valor es su ruta |
Un enum tuyo como tipo de la variable también da un desplegable.
Ordenar el inspector: grupos
Cuando un actor tiene muchos valores editables, agrúpalos. Todo lo que va después de @group
entra en ese grupo, y lo que va después de @subgroup, en un subgrupo dentro de él:
module Jugador
@group("Movimiento")@editable mut velocidad : float = 5.0@editable mut salto : float = 8.0@subgroup("Aire")@editable mut control_aire : float = 0.3
fn _ready() void { print($"{velocidad} {salto} {control_aire}")}Los grupos solo cambian cómo se ve el inspector: en el código, las variables se usan igual.
@onready: esperar a que el actor esté listo
El valor inicial de una variable del script se calcula cuando el script arranca, antes de que
el actor esté en la escena. Si ese valor depende de otro actor, todavía no puedes leerlo.
@onready lo retrasa hasta que el actor está listo, justo antes de _ready:
module Nivel
use actor::Jugador as jugador : Spatial2D
@onready mut inicio : Vector2 = jugador.position
fn _ready() void { print(inicio)}En esta escena, Jugador es un actor hijo colocado en (10, 20). Sin @onready, la línea de
inicio falla: jugador todavía no se puede encontrar.
En un watch, @onready hace además que el bloque se ejecute una vez al empezar, con el valor
actual, y no solo con el primer cambio.
No juntes @onready y @editable en la misma variable. El valor del inspector se aplica primero,
y @onready lo pisaría después con el de por defecto. Grost no te deja:
module Enemigo
@onready @editable mut velocidad : float = 5.0
fn _ready() void { print(velocidad)}@tool: código que corre en el editor
Los scripts normalmente solo corren en el juego. @tool, escrito detrás del nombre del módulo,
hace que el script corra también dentro del editor. Su uso más conocido es un botón en el
inspector, que solo existe en scripts @tool:
module Generador @tool
@editable mut semilla : int = 42@button("Generar") mut generar : Callable = regenerar
fn regenerar() void { print($"generando con la semilla {semilla}")}
fn _ready() void { regenerar()}@button("Generar")pone un botón con ese texto en el inspector. La variable es unCallable, y su valor es la función que llama el botón:regenerar, sin paréntesis.- Sin
@tool,@buttones un error.
Resumen
| Anotación | Dónde | Qué hace |
|---|---|---|
@editable, @range, @options… | Variables mut | Muestran el valor en el inspector |
@group, @subgroup | Antes de variables editables | Las agrupan en el inspector |
@onready | Variables, watch | Les da valor cuando el actor está listo |
@persistent | Structs, interfaces globales | Añade save y load |
@tool | Detrás del nombre del módulo | El script corre también en el editor |
@button | Una variable Callable de un script @tool | Un botón en el inspector |
En los juegos en red verás otras, como @replicated, @owner o @action, que dicen dónde se
decide y dónde corre cada cosa.
Hora de practicar
¿Cómo se escribe en Grost una variable que se puede cambiar desde el inspector?
@editable. @export no existe (es de GDScript), y sin @ no es una anotación.@ y una palabra que diga que se puede editar.¿Qué imprime este código?
@options("Fácil", "Normal", "Difícil") mut dificultad : int = 2
fn _ready() void {
print(dificultad)
}@options, el valor es un int: la posición de la opción, empezando en 0. El 2 es "Difícil", pero lo que se imprime es el número.Completa el código: las dos variables deben salir en el inspector, dentro del grupo Movimiento.
13.0
("Movimiento")
@editable mut velocidad : float = 5.0
mut salto : float = 8.0
fn _ready() void {
print(velocidad + salto)
}@group("Movimiento")
@editable mut velocidad : float = 5.0
@editable mut salto : float = 8.0
fn _ready() void {
print(velocidad + salto)
}¿Por qué no se juntan @onready y @editable en la misma variable?
@onready asigna su valor después de que se aplique el del inspector, así que lo pisaría. Grost lo trata como un error.@onready llega después.