REFERENCIA DE BLOQUES / UI

UI

Textos, botones, imágenes, barras, diálogos, menús y tipografías.

17 bloques

Choice menu

Accióngame.choice
Choice menu

Muestra un menú de teclado sobre tus textos de UI, pausa el script hasta que el jugador elige y guarda el número elegido.

Las flechas o WASD mueven la selección (con varias columnas, arriba/abajo se mueven de a una fila). Confirmar guarda 1, 2, 3...; una tecla de cancelar guarda 0. Las opciones siguen visibles después, así que ocultalas con Hide UI si hace falta. Mientras está abierto, Dialogue or menu is open es verdadero y Walk on grid se pausa. Si falta el objeto de una opción, el juego se detiene con un error.

CampoQué significa
option UI textstextoNombres de los objetos de UI que funcionan como opciones, separados por comas y en orden.Por defecto: Option1, Option2
labels a|b {…}textoTextos opcionales para las opciones, separados por | (por ejemplo Fight|Run). Acepta {plantillas}. Vacío conserva los textos actuales.
answer intotextoVariable que recibe la respuesta: choice (este objeto), Player.choice (otro objeto) o global.choice.Por defecto: choice
cursor UItextoUI u objeto opcional que se ubica 8 píxeles a la izquierda de la opción seleccionada, centrado en vertical.
columnsnúmeroCantidad de columnas de la grilla de opciones (de 1 a 12). Izquierda/derecha solo funcionan con más de una columna.Por defecto: 1
start atnúmeroOpción seleccionada al abrir el menú, empezando en 1.Por defecto: 1
confirm keystextoTeclas que confirman, separadas por espacios (por ejemplo z enter space).Por defecto: z enter space
cancel keystextoTeclas que cancelan y guardan 0. Vacío significa que el menú no se puede cancelar.
selected colourtextoColor del texto de la opción seleccionada, en formato #RRGGBB. Solo se aplica a opciones que son UI Text.Por defecto: #ffe28a
normal colourtextoColor del texto de las demás opciones, en formato #RRGGBB.Por defecto: #f3ead7
move soundlistaSonido opcional al mover la selección.
confirm soundlistaSonido opcional cuando el jugador confirma o cancela.

Ejemplo Después de un Say in dialogue box, ofrecé Yes|No y ramificá según choice con un If.

Disable Button

Acciónui_disable_button
Disable Button

Desactiva un UI Button para que ignore el hover y los clics y muestre su aspecto desactivado.

Un botón desactivado usa su color o imagen de desactivado y nunca dispara When This Button Clicked. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del UI Button (no distingue mayúsculas de minúsculas).Por defecto: Label

Ejemplo Desactivá un botón Buy mientras el jugador no pueda pagar el objeto.

Enable Button

Acciónui_enable_button
Enable Button

Vuelve a activar un UI Button para que reaccione al hover y a los clics.

Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del UI Button (no distingue mayúsculas de minúsculas).Por defecto: Label

Hide UI

Acciónui_hide
Hide UI

Oculta un objeto de UI (texto, imagen o botón).

Solo funciona con objetos de UI. Un UI Button oculto se puede seguir clickeando en su lugar, así que usá también Disable Button si tiene que dejar de responder. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del objeto de UI a cambiar (no distingue mayúsculas de minúsculas).Por defecto: Label

Ejemplo Ocultá un texto Paused cuando el juego se reanuda.

Say in dialogue box

Accióngame.dialogue
Say in dialogue box

Escribe un texto letra por letra en un texto de UI y pausa el script hasta que el jugador aprieta una tecla.

Si apretás una tecla mientras escribe, muestra la línea completa; la siguiente la cierra. Escribí \n para un salto de línea. Mientras está abierto, Dialogue or menu is open es verdadero y Walk on grid se pausa; otros controles como Platformer controls siguen funcionando. Si falta un objeto de UI, el juego se detiene con un error, así que vaciá box UI si no tenés caja.

CampoQué significa
text {…}textoLa línea a mostrar. Acepta {plantillas} como {Player.name} o {global.gold}.Por defecto: Hello, traveller!
speaker {…}textoNombre que se escribe en name UI. Acepta {plantillas}.
text UItextoUI Text que recibe el texto. Obligatorio.Por defecto: DialogueText
box UItextoObjeto de fondo opcional que se muestra mientras el diálogo está abierto.Por defecto: DialogueBox
name UItextoUI Text opcional para el nombre de quien habla.
'more' UItextoObjeto opcional que aparece cuando la línea terminó de escribirse, como una flechita.
letters / secnúmeroLetras por segundo. 0 muestra la línea completa de una.Por defecto: 45
keys (space separated)textoTeclas que adelantan y continúan, separadas por espacios.Por defecto: z enter space
bliplistaSonido opcional que suena cada 3 letras mientras escribe.
hide afterlistaon oculta la caja, el texto y el nombre al cerrar la línea; off los deja visibles, ideal para varias líneas seguidas.Opciones: on · off

Ejemplo Encadená varios en un script When Scene Starts para una charla de introducción, con hide after en off salvo en el último.

Set bar

Accióngame.set_bar
Set bar

Cambia el ancho de una barra a valor / máximo de su ancho completo, con una imagen opcional para cada nivel.

El ancho se anima con una desaceleración durante seconds, manteniendo fijo el borde izquierdo. En 0 o menos la barra se oculta; por encima de 0 se muestra. Si falta el objeto de la barra o el valor no es un número, el juego se detiene con un error.

CampoQué significa
bartextoNombre del objeto barra: un UI Image o un sprite común.Por defecto: HPBar
value {…}textoValor actual. Acepta {plantillas} como {hp} o {Player.hp}.Por defecto: {hp}
of {…}textoValor máximo. Acepta {plantillas}. 0 o menos cuenta como barra vacía.Por defecto: {max_hp}
full widthnúmeroAncho en píxeles cuando la barra está llena.Por defecto: 200
secondsnúmeroDuración de la animación en segundos. 0 cambia el tamaño al instante.Por defecto: 0.3
image > 50%listaImagen opcional cuando la barra está por encima del 50%.
image > 20%listaImagen opcional entre el 20% y el 50%.
image lowlistaImagen opcional con el 20% o menos.

Ejemplo Ejecutalo cuando el jugador recibe daño, con imágenes verde, amarilla y roja para los tres niveles.

Set Button Image

Acciónui_set_button_image
Set Button Image

Cambia la imagen que muestra un UI Button en uno de sus estados.

Las imágenes solo se ven cuando el modo de fondo del botón está en imagen en el Inspector; en modo color el cambio se guarda pero no se ve. Si hover, pressed o disabled están vacíos, se usa la imagen normal. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del UI Button (no distingue mayúsculas de minúsculas).Por defecto: Button
StatelistaQué estado cambiar: normal, hover, pressed o disabled.Opciones: normal · hover · pressed · disabled
ImagelistaImagen de los assets del proyecto. Vacío quita la imagen de ese estado.

Set Button Text

Acciónui_set_button_text
Set Button Text

Cambia la etiqueta que muestra un UI Button.

Solo funciona con UI Buttons; Set UI Text sirve tanto para textos como para botones. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del UI Button (no distingue mayúsculas de minúsculas).Por defecto: Button
TexttextoNueva etiqueta. Si conectás un bloque en el hueco (número, texto o booleano), se convierte a texto.Por defecto: Click Me
TextencastreNueva etiqueta. Si conectás un bloque en el hueco (número, texto o booleano), se convierte a texto.Por defecto: string, number, boolean, any

Ejemplo Cambiá un botón Start a Continue cuando ya existe una partida guardada.

Set UI Color

Acciónui_set_color
Set UI Color

Cambia un color de un UI Text o de un UI Button.

En un UI Text siempre cambia el color del texto y se ignora Role. En un UI Button, Role elige qué parte recolorear. Los UI Image no tienen color (usá Set UI Opacity). Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del objeto de UI a cambiar (no distingue mayúsculas de minúsculas).Por defecto: Label
RolelistaParte del botón a recolorear: text (etiqueta), normal, hover, pressed, disabled (fondo en cada estado) o tint (capa sobre botones con imagen; solo se ve si la opacidad del tinte del botón es mayor a 0).Opciones: text · normal · hover · pressed · disabled · tint
ColortextoColor en código hexadecimal, como #ff8800. Los colores inválidos se reemplazan por el predeterminado al dibujar.Por defecto: #ffffff
ColorencastreColor en código hexadecimal, como #ff8800. Los colores inválidos se reemplazan por el predeterminado al dibujar.Por defecto: string, any

Ejemplo Poné en rojo un texto de temporizador con #ff4040 cuando quedan menos de 10 segundos.

Set UI Font

Acciónui_set_font
Set UI Font

Cambia la fuente, y opcionalmente el tamaño, de un UI Text o UI Button.

Si el archivo de fuente no existe, se registra un aviso una sola vez y se mantiene la fuente actual (el tamaño igual se cambia). Solo acepta UI Text y UI Button; con otros objetos registra un aviso.

CampoQué significa
UItextoNombre del UI Text o UI Button (no distingue mayúsculas de minúsculas).Por defecto: Label
FonttextoUn archivo de fuente del proyecto (.ttf u .otf) como assets/fonts/MyFont.ttf, una familia instalada como Arial, o Default para volver a la fuente predeterminada.Por defecto: Default
Size (0 = keep)númeroNuevo tamaño en píxeles, de 1 a 512. 0 conserva el tamaño actual.Por defecto: 0

Ejemplo Cambiá un título a una fuente pixelada cuando empieza el juego.

Set UI Font Size

Acciónui_set_font_size
Set UI Font Size

Cambia el tamaño de fuente de un UI Text o UI Button.

El tamaño está en píxeles, se redondea hacia abajo a un número entero y el mínimo es 1. El texto también escala con el zoom de la cámara. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del objeto de UI a cambiar (no distingue mayúsculas de minúsculas).Por defecto: Label
SizenúmeroTamaño de fuente en píxeles. Si conectás un bloque en el hueco, reemplaza el valor escrito.Por defecto: 24
SizeencastreTamaño de fuente en píxeles. Si conectás un bloque en el hueco, reemplaza el valor escrito.Por defecto: number, any

Set UI Image

Acciónui_set_image
Set UI Image

Cambia la imagen de un UI Image, o la imagen normal de un UI Button.

En un botón reemplaza solo la imagen del estado normal, que se ve únicamente en modo de fondo con imagen. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del objeto de UI a cambiar (no distingue mayúsculas de minúsculas).Por defecto: Image
ImagelistaImagen de los assets del proyecto. Vacío deja en blanco un UI Image.

Ejemplo Cambiá la imagen de un retrato según quién está hablando.

Set UI Opacity

Acciónui_set_opacity
Set UI Opacity

Define qué tan opaco es un objeto de UI, de 0 (invisible) a 1 (sólido).

Los valores se limitan entre 0 y 1. Se nota en UI Image y UI Button; los UI Text por ahora lo ignoran al dibujarse, así que para textos usá Hide UI o Set UI Color. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del objeto de UI a cambiar (no distingue mayúsculas de minúsculas).Por defecto: Label
OpacitynúmeroOpacidad de 0 a 1. Si conectás un bloque en el hueco, reemplaza el valor escrito.Por defecto: 1
OpacityencastreOpacidad de 0 a 1. Si conectás un bloque en el hueco, reemplaza el valor escrito.Por defecto: number, any

Ejemplo Poné 0.5 en el ícono de un menú bloqueado para que se vea apagado.

Set UI Text

Acciónui_set_text
Set UI Text

Cambia el texto de un UI Text o la etiqueta de un UI Button.

En un UI Text, el texto se dibuja desde la esquina superior izquierda y se ajusta al ancho del objeto. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del objeto de UI a cambiar (no distingue mayúsculas de minúsculas).Por defecto: Label
TexttextoNuevo texto. Si conectás un bloque en el hueco (número, texto o booleano), se convierte a texto.Por defecto: Hello
TextencastreNuevo texto. Si conectás un bloque en el hueco (número, texto o booleano), se convierte a texto.Por defecto: string, number, boolean, any

Ejemplo Conectá un reportero de variable en Text dentro de On Update para mostrar el puntaje.

Set UI text from template

Accióngame.text_from_vars
Set UI text from template

Pone en un texto de UI una plantilla, reemplazando cada {referencia} por el valor actual de una variable.

{nombre} lee una variable de este objeto, {Objeto.nombre} la de otro objeto y {global.nombre} una global; x, y, width, height y name también funcionan como propiedades. Las referencias desconocidas quedan tal cual. Los números enteros se muestran sin decimales y el resto con hasta 2. No hace nada si no encuentra el objeto de UI.

CampoQué significa
UItextoNombre del UI Text o UI Button a actualizar.Por defecto: Label
texttextoTexto con {referencias}, por ejemplo Score {score} Lives {Player.lives}.Por defecto: Score {score}

Ejemplo Dentro de On Update de un objeto del HUD para mantener actualizado Coins {global.coins}.

Set UI Value (Unsupported)

Acciónui_set_value
Set UI Value (Unsupported)

Reservado: por ahora no tiene ningún efecto al ejecutarse.

Está pensado para barras de progreso, pero todavía no está implementado. Usá Set bar para mostrar un valor como barra.

CampoQué significa
UItextoNombre del objeto de UI. Por ahora se ignora.Por defecto: ProgressBar
ValuenúmeroValor a asignar. Por ahora se ignora.Por defecto: 50
ValueencastreValor a asignar. Por ahora se ignora.Por defecto: number, any

Show UI

Acciónui_show
Show UI

Muestra un objeto de UI (texto, imagen o botón) que estaba oculto.

Solo funciona con objetos de UI. Si el objeto no existe o no es del tipo correcto, se escribe un mensaje en la consola y el juego sigue.

CampoQué significa
UItextoNombre del objeto de UI a cambiar (no distingue mayúsculas de minúsculas).Por defecto: Label

Ejemplo Mostrá un texto Game Over cuando el jugador se queda sin vidas.