Referencia API

Referencia API Completa

También disponible en forma corta dentro del Editor mismo:

Constructores de Activos

Los constructores crean los principales tipos de activos utilizados por el editor. Cuando asignas uno a una variable, el editor lo reconoce y te permite abrir el editor de activos correspondiente con Ctrl+Click.

Métodos de Lista

Crea listas con [] o [valor1, valor2, ...]. Lee y sobrescribe entradas con list[index], y itera con for (var i = 0; i < list.length(); i = i + 1).

Operadores

Los operadores son pequeños símbolos que realizan cálculos comunes. El operador módulo es especialmente útil para envolver temporizadores, índices, pasos de animación o patrones repetidos.

Propiedades del Objeto

Los objetos son las cosas que tu script generalmente mueve y cambia durante el juego. Estas funciones leen o actualizan la posición, sprite, comportamiento de colisión, capa y tinte visual de un objeto.

Funciones de Sprite

Las funciones de sprite permiten al código inspeccionar o modificar los datos de píxeles del sprite y la velocidad de animación. La mayoría de los juegos dibujan sprites en el editor, pero estas funciones son útiles para efectos procedurales, depuración o cambios simples en tiempo de ejecución.

Funciones de Animación

Las funciones de animación trabajan con objetos que utilizan sprites con múltiples cuadros. Úsalas cuando desees que el código inspeccione o fuerce el cuadro de animación actual.

Funciones de Transformación (Inversión/R rotación)

Las funciones de transformación cambian cómo se dibuja el sprite de un objeto sin editar el sprite en sí. Son buenas para reutilizar un sprite en múltiples direcciones.

Nota: Estas transformaciones se aplican solo en el momento de renderizar. No afectan a las cajas de colisión ni a los datos de píxeles del sprite.

Tipos de Colisión

Los tipos de colisión deciden cómo participa un objeto en las verificaciones de colisión. Elige el tipo en función del rol del objeto: las paredes suelen ser estáticas, los jugadores suelen ser dinámicos y las recogidas suelen ser disparadores.

Funciones de Escena

Las funciones de escena controlan qué escena está activa, qué objetos están dentro de ella y configuraciones a nivel de escena como el color de fondo y la gravedad. También proporcionan ayudas de búsqueda para encontrar objetos en posiciones o por nombre.

Reproducción de Audio

Las funciones de reproducción de audio inician y detienen activos de audio desde el script. playAudio() devuelve un identificador para que puedas detener o verificar más tarde esa instancia de reproducción específica.

Funciones de Pantalla

Las funciones de pantalla ayudan cuando necesitas conocer el tamaño de la ventana o convertir entre píxeles de pantalla y posiciones en el mundo. Esto es útil para apuntar con el ratón, detectar clics y UI consciente de la cámara.

Modo de Ventana

Controla el modo de ventana para juegos exportados. Estas funciones no tienen efecto al jugar en el editor (el editor tiene mayor autoridad sobre el estado de la ventana).

Ejemplo:

func start() {
    // Establece el modo de ventana (WINDOW_MAXIMIZED es el predeterminado para juegos exportados)
    setWindowMode(WINDOW_MAXIMIZED())
}

Nota: Si setWindowMode() nunca se llama en un juego exportado, el predeterminado es WINDOW_MAXIMIZED.

Funciones de UI

La UI utiliza una resolución de espacio de pantalla virtual. El espacio de UI predeterminado es 100 x 100. El tamaño de fuente se puede aumentar para los siguientes widgets de texto con uiPushFontSize(size) y restaurar con uiPopFontSize(). Los colores de fuente se pueden apilar con uiPushFontColor(r, g, b[, a]), y los rellenos de los elementos de UI se pueden apilar con uiPushElementColor(r, g, b[, a]). Al igual que el resto de la UI de modo inmediato, estas sobreescrituras se aplican mientras se construye la UI del marco actual. Si el tamaño empujado es 0 o menos, el motor utiliza un tamaño automático.

Constantes de Estado de la UI

Las funciones de la UI devuelven constantes de estado para que tu script pueda saber si un widget está inactivo, sobre él, presionado o clicado. Normalmente, UI_CLICKED() es el valor que verificas para las acciones de botones.

Funciones de Cámara

La posición de la cámara representa el centro de la vista. El zoom mantiene una vista del mundo vertical consistente independientemente del tamaño de la pantalla.

Comportamiento del zoom: El zoom mantiene una vista del mundo vertical consistente independientemente del tamaño de la ventana o la relación de aspecto. Pantallas más anchas muestran más horizontalmente pero la misma cantidad verticalmente.

Funciones de Entrada

Las funciones de entrada permiten que el juego reaccione al estado del teclado y del mouse. Usa Pressed para acciones de un frame, Held para movimiento continuo, y Released para acciones que ocurren cuando se suelta un botón.

Constantes de Botón del Mouse

Las constantes de botón del mouse se pasan a las funciones de entrada del mouse. Hacen que el código sea más fácil de leer que números en crudo.

Constantes de Tecla

Las constantes de tecla se pasan a las funciones de entrada del teclado. El motor expone letras, números, teclas de función, flechas, y un pequeño conjunto de teclas especiales comunes.

Letras: KEY_A() hasta KEY_Z()

Números: KEY_0() hasta KEY_9()

Teclas de función: KEY_F1() hasta KEY_F12()

Teclas especiales: | Constante | Tecla | |----------|-----| | KEY_SPACE() | Barra espaciadora | | KEY_ENTER() | Enter/Retorno | | KEY_ESCAPE() | Escape | | KEY_TAB() | Tab | | KEY_BACKSPACE() | Retroceso | | KEY_DELETE() | Suprimir | | KEY_SHIFT() | Shift | | KEY_CTRL() | Control | | KEY_ALT() | Alt | | KEY_LEFT() | Flecha izquierda | | KEY_RIGHT() | Flecha derecha | | KEY_UP() | Flecha arriba | | KEY_DOWN() | Flecha abajo | | KEY_HOME() | Inicio | | KEY_END() | Fin |

Funciones Matemáticas

Los ayudantes matemáticos cubren cálculos comunes utilizados en movimiento, animación, aleatoriedad y límites de valores. Mantienen los scripts más cortos y fáciles de leer.

Funciones de Utilidad

Las funciones de utilidad son ayudantes generales que no pertenecen a un tipo específico de activo. print() es especialmente útil mientras aprendes ya que muestra lo que está haciendo tu script.

Funciones de Cadenas

Las funciones de cadena trabajan con valores de texto. Por ahora, esta sección es intencionalmente pequeña.

Funciones de Almacenamiento

Guarda y carga datos del juego en archivos. Soporta números, cadenas, booleanos y listas (incluidas listas anidadas). No soporta valores de Sprite, Scene, Object o Audio.

Ejemplo: Guardando y Cargando el Progreso del Jugador

// Guarda los datos del jugador
var playerData = [100, "Jugador1", true, [1, 2, 3]]
var savePath = getAppDataPath() + "/MyGame/save.dat"
if (save(savePath, playerData)) {
    print("Juego guardado!")
}

// Carga los datos del jugador
if (fileExists(savePath)) {
    var loaded = load(savePath)
    if (loaded != null) {
        var health = loaded[0]
        var name = loaded[1]
        var hasKey = loaded[2]
        var inventory = loaded[3]
    }
}

// Guarda encriptada (para ocultar datos de inspección casual)
var secretData = ["secreto", 12345]
save(getAppDataPath() + "/MyGame/config.dat", secretData, "binary", "miClaveSecreta")
var decrypted = load(getAppDataPath() + "/MyGame/config.dat", "miClaveSecreta")

// Formato de texto (legible para humanos, útil para depuración)
save(getAppDataPath() + "/MyGame/debug.txt", playerData, "text")

Notas:

• El formato binario (por defecto) es compacto y más rápido
• El formato de texto es legible para humanos, útil para depuración
• Una clave de encriptación incorrecta devuelve null (los datos serán basura)
• Los directorios se crean automáticamente al guardar