Esta es toda la API pública de Lua disponible en Play Mode del editor y en una compilación de PS1. Los nombres distinguen entre mayúsculas y minúsculas. Los parámetros opcionales aparecen entre corchetes. El archivo .polygon/lua/POLYGON_LUA_API.md generado dentro de un proyecto configurado proviene de la misma declaración del engine y es la referencia local exacta de la versión instalada.
Callbacks del ciclo de vida
| Devolución de llamada | Cuando se ejecuta |
|---|
Awake(gameObjectId) | Una vez cargado el Lua Behaviour. |
OnEnable(gameObjectId) | Siempre que el Lua Behaviour se vuelva activo. |
Start(gameObjectId) | Antes del primer Update. |
FixedUpdate(gameObjectId, fixedDeltaTime) | En la etapa de simulación de 30 Hz limitada. |
Update(gameObjectId, deltaTime) | Una vez por cuadro renderizado. |
LateUpdate(gameObjectId, deltaTime) | Después de Update. |
OnCollisionEnter(gameObjectId, otherGameObjectId) | Cuando se inicia una colisión. |
OnCollisionStay(gameObjectId, otherGameObjectId) | Mientras la colisión permanece activa. |
OnCollisionExit(gameObjectId, otherGameObjectId) | Cuando termina una colisión. |
OnTriggerEnter(gameObjectId, otherGameObjectId) | Cuando comienza la superposición con un trigger. |
OnTriggerStay(gameObjectId, otherGameObjectId) | Mientras continúa la superposición con un trigger. |
OnTriggerExit(gameObjectId, otherGameObjectId) | Cuando termina la superposición con un trigger. |
OnDisable(gameObjectId) | Cuando el Lua Behaviour se vuelve inactivo. |
OnDestroy(gameObjectId) | Antes de que se libere el estado de script. |
Núcleo
Log y Time
| Método | Retorno | Finalidad |
|---|
Log.Print(message) | ninguno | Escribe una línea de registro segura en tiempo de ejecución. |
Time.DeltaTime() | número | Devuelve el delta de cuadros escalado en segundos. |
Time.UnscaledDeltaTime() | número | Devuelve delta de cuadro antes de aplicar la escala de tiempo. |
Time.GetTimeScale() | número | Devuelve la escala de tiempo de juego actual. |
Time.SetTimeScale(scale) | booleano | Establece la escala de tiempo en 0.0..4.0; cero pausa la simulación escalada mientras la interfaz de usuario, la entrada y las callbacks de cuadro Lua permanecen activas. |
| Método | Retorno | Finalidad |
|---|
Transform.GetPosition(gameObjectId) | Vec3 o nil | Lee la posición mundial. |
Transform.SetPosition(gameObjectId, position) | booleano | Establece la posición mundial desde un Vec3. |
Transform.SetPosition(gameObjectId, x, y, z) | booleano | Establece la posición mundial de escalares. |
Transform.GetPositionX/Y/Z(gameObjectId) | número o nil | Lee un eje de posición mundial. |
Transform.GetRotation(gameObjectId) | Vec3 o nil | Lee la rotación de Euler en grados. |
Transform.SetRotation(gameObjectId, rotation) | booleano | Establece la rotación de Euler desde un Vec3. |
Transform.SetRotation(gameObjectId, x, y, z) | booleano | Establece la rotación de Euler desde escalares. |
Transform.GetRotationX/Y/Z(gameObjectId) | número o nil | Lee un eje de Euler. |
Transform.GetScale(gameObjectId) | Vec3 o nil | Lee la escala local. |
Transform.SetScale(gameObjectId, scale) | booleano | Establece la escala desde un Vec3. |
Transform.SetScale(gameObjectId, x, y, z) | booleano | Establece la escala a partir de escalares. |
Transform.GetScaleX/Y/Z(gameObjectId) | número o nil | Lee un eje de escala. |
Transform.RotateX/Y/Z(gameObjectId, degrees) | booleano | Gira alrededor de un eje. |
Transform.Translate(gameObjectId, x, y, z) | booleano | Aplica una traslación en coordenadas de mundo. |
Los ajustadores Transform rechazan valores PS1 no finitos o fuera de rango en lugar de corromper silenciosamente el estado de la escena.
GameObject
| Método | Retorno | Finalidad |
|---|
GameObject.Find(name) | entero | Encuentra un GameObject por nombre exacto, incluidos los objetos inactivos en la implementación actual, o -1. |
GameObject.Exists(gameObjectId) | booleano | Verifica la validez de la identificación. |
GameObject.GetName(gameObjectId) | cadena o nil | Lee el nombre visible del GameObject. |
GameObject.IsActive(gameObjectId) | booleano o nil | Lee el estado activo. |
GameObject.SetActive(gameObjectId, active) | booleano | Cambia el estado activo. |
GameObject.Invoke(gameObjectId, functionName[, int1, int2, string1, string2]) | booleano | Llama a una función en el Lua Behaviour de destino. |
GameObject.CompareTag(gameObjectId, tag) | booleano | Compara una etiqueta de preprocesamiento sin asignar. |
GameObject.GetLayer(gameObjectId) | entero | Lee la capa de física/render. |
GameObject.SetLayer(gameObjectId, layer) | booleano | Cambia la capa dentro del rango permitido. |
| Método | Retorno | Finalidad |
|---|
Input.GetButton(buttonOrAction) | booleano | Prueba una constante de botón físico o acción semántica. |
Input.GetButtonDown(buttonOrAction) | booleano | Verdadero únicamente en el cuadro en que se presiona. |
Input.GetButtonUp(buttonOrAction) | booleano | Verdadero únicamente en el cuadro en que se suelta. |
Input.GetAxis([stickOrAction], [deadZone]) | número, número | Devuelve X/Y normalizado en -1.0..1.0, con una zona muerta suave opcional para los sticks. No filtra el movimiento del mouse capturado. |
Input.IsConnected() | booleano | Informa el estado de conexión del controlador del puerto 1. |
Input.HasAnalog() | booleano | Informa si hay entrada analógica disponible. |
Input.GetPadType() | entero | Devuelve el código de tipo de controlador PS1. |
Constantes de botones: CROSS, CIRCLE, SQUARE, TRIANGLE, UP, DOWN, LEFT, RIGHT, START, SELECT, L1, L2, L3, R1, R2 y R3. Selector de sticks: STICK_LEFT y STICK_RIGHT.
| Método | Retorno | Finalidad |
|---|
PlayerInput.SetEnabled(gameObjectId, enabled) | booleano | Cambia el estado de ejecución PlayerInput sin desactivar el GameObject o el LuaBehaviour. |
PlayerInput.IsEnabled(gameObjectId) | booleano o nil | Lee el estado de tiempo de ejecución o devuelve nil cuando el componente está ausente. |
Al deshabilitar PlayerInput se detiene el movimiento nativo, el control de la cámara, la interacción y las indicaciones de interacción. Las consultas Input permanecen activas para menús y secuencias de comandos personalizadas.
Rumble
| Método | Retorno | Finalidad |
|---|
Rumble.Play([lowFrequency, highFrequency, durationSeconds]) | booleano | Inicia vibración limitada. |
Rumble.Stop() | ninguno | Detiene la vibración. |
Rumble.IsSupported() | booleano | Reporta capacidad de vibración. |
Audio y presentación
AudioSource y Music
| Método | Retorno | Finalidad |
|---|
AudioSource.Play(gameObjectId) | booleano | Reproduce el clip de residente asignado. |
AudioSource.PlayOneShot(gameObjectId) | booleano | Inicia una voz independiente de un solo disparo para el clip asignado. |
AudioSource.Stop(gameObjectId) | booleano | Detiene la reproducción. |
AudioSource.SetVolume(gameObjectId, volume) | booleano | Establece el volumen normalizado de la fuente. |
AudioSource.SetPan(gameObjectId, pan) | booleano | Establece el paneo estéreo en -1.0..1.0. |
AudioSource.IsPlaying(gameObjectId) | booleano | Lee el estado de reproducción de origen. |
Music.Play(name[, loop]) | booleano | Inicia una pista CD-XA transmitida con nombre. |
Music.Stop() | booleano | Deja de transmitir música. |
Music.SetVolume(volume) | booleano | Establece el volumen de música transmitida. |
Music.IsPlaying() | booleano | Lee estado de música en streaming. |
Camera
| Método | Retorno | Finalidad |
|---|
Camera.Has(gameObjectId) | booleano | Comprueba si hay un componente Camera. |
Camera.GetActive() | entero | Devuelve el Camera GameObject activo. |
Camera.GetFieldOfView(gameObjectId) | número o nil | Lee el campo de visión vertical. |
Camera.SetFieldOfView(gameObjectId, degrees) | booleano | Establece el campo de visión vertical. |
Light
| Método | Retorno | Finalidad |
|---|
Light.Has(gameObjectId) | booleano | Comprueba si hay un componente Light. |
Light.GetDirection(gameObjectId) | Vec3 o nil | Lee la dirección de la luz. |
Light.SetDirection(gameObjectId, x, y, z) | booleano | Establece la dirección de la luz. |
Light.GetColor(gameObjectId) | Tabla RGB o nil | Lee color direccional de 8 bits. |
Light.SetColor(gameObjectId, r, g, b) | booleano | Establece el color direccional de 8 bits. |
Light.GetIntensity(gameObjectId) | número o nil | Lee intensidad. |
Light.SetIntensity(gameObjectId, intensity) | booleano | Establece la intensidad. |
Light.GetAmbient(gameObjectId) | Tabla RGB o nil | Lee el color ambiente de 8 bits. |
Light.SetAmbient(gameObjectId, r, g, b) | booleano | Establece el color ambiental de 8 bits. |
ParticleSystem
| Método | Retorno | Finalidad |
|---|
ParticleSystem.Emit(x, y, z, vx, vy, vz, lifetime[, r, g, b]) | ninguno | Emite una partícula de tipo billboard dentro de los límites de capacidad. |
ParticleSystem.Clear() | ninguno | Limpia todas las partículas emitidas. |
Physics y el movimiento
Collider
Collider.ShapeBox y Collider.ShapeSphere identifican las formas soportadas.
| Método | Retorno | Finalidad |
|---|
Collider.Has(gameObjectId) | booleano | Comprueba si hay un Collider. |
Collider.GetShape(gameObjectId) | entero o nil | Lee la constante de forma. |
Collider.SetShape(gameObjectId, shape) | booleano | Establece una forma soportada. |
Collider.IsTrigger(gameObjectId) | booleano | Consulta si el Collider funciona como trigger. |
Collider.SetIsTrigger(gameObjectId, isTrigger) | booleano | Cambia si el Collider funciona como trigger. |
Collider.GetSize(gameObjectId) | Vec3 o nil | Lee el tamaño de la caja. |
Collider.SetSize(gameObjectId, x, y, z) | booleano | Establece el tamaño de la caja. |
Collider.GetRadius(gameObjectId) | número o nil | Lee el radio de la esfera. |
Collider.SetRadius(gameObjectId, radius) | booleano | Establece el radio de la esfera. |
Physics
| Método | Retorno | Finalidad |
|---|
Physics.IsColliding(gameObjectId[, otherGameObjectId]) | booleano | Prueba cualquier colisión o un par específico. |
Physics.GetCollisionCount(gameObjectId) | entero | Cuenta las colisiones activas. |
Physics.Raycast(ox, oy, oz, dx, dy, dz, maxDistance[, layerMask, queryTriggers]) | impacto, ID, punto XYZ, normal XYZ, distancia | Realiza un raycast sin asignación. |
CharacterController
| Método | Retorno | Finalidad |
|---|
CharacterController.Move(gameObjectId, x, y, z) | booleano | Se mueve a través del mundo de la colisión cinemática. |
CharacterController.IsGrounded(gameObjectId) | booleano | Lee estado en contacto con el suelo. |
CharacterController.GetVelocityY(gameObjectId) | número | Lee la velocidad vertical. |
CharacterController.SetVelocityY(gameObjectId, velocity) | booleano | Establece la velocidad vertical. |
Escenas, navegación e interacción
SceneManager
| Método | Retorno | Finalidad |
|---|
SceneManager.LoadScene(scenePath[, options]) | booleano | Solicita una escena incluida en la compilación; admite EntryPoint y Presentation. True significa aceptada, no terminada. |
SceneManager.GetEntryPoint() | cadena | Lee el nombre de entrada antes de Start en el destino. |
NavMesh y NavMeshAgent
NavMeshAgent.PathInvalid y NavMeshAgent.PathComplete son las constantes de estado de la ruta actual.
| Método | Retorno | Finalidad |
|---|
NavMesh.FindPath(sx, sy, sz, ex, ey, ez) | tabla | Devuelve una ruta completa de como máximo 32 puntos Vec3, o una tabla vacía. |
NavMesh.SamplePosition(x, y, z, maxDistance[, surfaceGameObjectId]) | encontrado, x, y, z | Encuentra el punto más cercano en una NavMesh preprocesada. |
NavMeshAgent.SetDestination(gameObjectId, x, y, z) | booleano | Inicia el movimiento hacia un destino de ruta completa. |
NavMeshAgent.Stop(gameObjectId) | ninguno | Detiene y despeja el movimiento del agente. |
NavMeshAgent.IsMoving(gameObjectId) | booleano | Lee el estado de movimiento activo. |
NavMeshAgent.HasPath(gameObjectId) | booleano | Informa si se posee una ruta válida. |
NavMeshAgent.HasReachedDestination(gameObjectId) | booleano | Prueba la distancia de parada. |
NavMeshAgent.IsOnNavMesh(gameObjectId) | booleano | Comprueba si el agente está asociado a una superficie preprocesada. |
NavMeshAgent.GetRemainingDistance(gameObjectId) | número | Lee la distancia de trayectoria restante limitada. |
NavMeshAgent.GetSpeed(gameObjectId) | número | Lee la velocidad de movimiento actual. |
NavMeshAgent.GetPathStatus(gameObjectId) | entero | Lee una constante de estado de ruta. |
Portal y Interactable
| Método | Retorno | Finalidad |
|---|
Portal.SetOpen(portalGameObjectId, open) | booleano | Cambia la conectividad de la Room a través de un Portal. |
Interactable.SetEnabled(gameObjectId, enabled) | booleano | Cambia el estado de interacción incorporado. |
Interactable.IsEnabled(gameObjectId) | booleano | Lee el estado de interacción incorporado. |
Animation y líneas de tiempo
| Método | Retorno | Finalidad |
|---|
Timeline.Play(name[, { OnComplete = fn }]) | booleano | Inicia una línea de tiempo creada. |
Timeline.Stop() | ninguno | Detiene la línea de tiempo activa. |
Timeline.IsPlaying() | booleano | Lee el estado de la línea de tiempo. |
Animation.Play(name[, loop]) | booleano | Inicia un clip independiente creado. |
Animation.Play(name[, { Loop = bool, OnComplete = fn }]) | booleano | Inicia un clip con opciones. |
Animation.Stop([name]) | ninguno | Detiene un clip o cada clip. |
Animation.IsPlaying([name]) | booleano | Prueba un clip o cualquier clip. |
TransformAnimator.Play(gameObjectId[, state]) | booleano | Inicia un estado de transformación. |
TransformAnimator.Stop(gameObjectId) | booleano | Detiene la transformación de la animación. |
TransformAnimator.SetSpeed(gameObjectId, speed) | booleano | Cambia la velocidad de reproducción. |
TransformAnimator.IsPlaying(gameObjectId) | booleano | Lee el estado de reproducción. |
TransformAnimator.SetState(gameObjectId, state) | booleano | Selecciona un estado de autoría. |
TransformAnimator.GetState(gameObjectId) | cadena o nil | Lee el estado seleccionado. |
Animator.Play(gameObjectId, clipName[, loop]) | booleano | Inicia un clip esquelético importado. |
Animator.Stop(gameObjectId) | booleano | Detiene la reproducción esquelética. |
Animator.IsPlaying(gameObjectId) | booleano | Lee el estado de reproducción esquelético. |
Animator.GetClip(gameObjectId) | cadena o nil | Lee el nombre del clip activo. |
Animator.ConsumeFinished(gameObjectId) | cadena o nil | Consume el nombre del clip sin bucle terminado. |
Autor UI
| Cuadro | Métodos |
|---|
UI | Find(name), GetType(elementId), GetCount(), DrawText(x, y, text), SetInputEnabled(enabled), SetSubmitButton(buttonOrAction), SetSelectionColor(r, g, b) |
Canvas | Find(name), SetEnabled(canvasId, enabled), IsEnabled(canvasId), SetSortOrder(canvasId, order), GetCount(), SetModal(canvasId) |
Text | SetText(elementId, text), GetText(elementId) |
Image | SetTexture(elementId, textureGuid), GetTexture(elementId) |
Button | SetInteractable(elementId, interactable), IsInteractable(elementId) |
RectTransform | SetPosition(elementId, x, y), GetPosition(elementId), SetSize(elementId, width, height), GetSize(elementId) |
Graphic | SetColor(elementId, r, g, b[, a]), GetColor(elementId), SetEnabled(elementId, enabled), IsEnabled(elementId) |
Selectable | Select(elementId), GetSelected() |
ProgressBar | SetValue(elementId, value), GetValue(elementId) |
UI.DrawText es una salida de depuración transitoria. Usar elementos de texto de autoría para la interfaz de usuario del jugador. Los ID de elementos de la interfaz de usuario son globales dentro de la escena; los ID de Canvas pertenecen a la colección Canvas.
Sesión y transiciones
Estos servicios se comportan igual en Play Mode y en PS1. Consulta
Sesión y transiciones para ver sus límites y la receta de puertas.
| Método | Retorno | Finalidad |
|---|
Session.Read(key) | cadena o nil | Lee datos de la partida que sobreviven a la carga de escenas. |
Session.Write(key, value) | booleano | Escribe una cadena acotada sin acceder a la Memory Card. |
Session.Delete(key) | booleano | Libera una entrada de sesión. |
ScreenFade.ToBlack([seconds]) | booleano | Oscurece la pantalla usando tiempo sin escalar. |
ScreenFade.FromBlack([seconds]) | booleano | Revela la escena desde la opacidad actual del fundido. |
ScreenFade.IsPlaying() | booleano | Indica si el fundido sigue cambiando. |
Persistencia
PlayerPrefs
| Método | Retorno | Finalidad |
|---|
PlayerPrefs.SetInt(key, value) | booleano | Almacena un entero. |
PlayerPrefs.GetInt(key[, defaultValue]) | entero | Lee un entero. |
PlayerPrefs.SetFloat(key, value) | booleano | Almacena un número finito de punto flotante. |
PlayerPrefs.GetFloat(key[, defaultValue]) | número | Lee un número de punto flotante. |
PlayerPrefs.SetString(key, value) | booleano | Almacena una cadena. |
PlayerPrefs.GetString(key[, defaultValue]) | string | Lee una cadena. |
PlayerPrefs.HasKey(key) | booleano | Comprueba si hay una preferencia escrita. |
PlayerPrefs.DeleteKey(key) | booleano | Elimina una preferencia tipada. |
PlayerPrefs.DeleteAll() | booleano | Elimina solo entradas PlayerPrefs. |
PlayerPrefs.Save() | booleano | Guarda las preferencias en el dispositivo de almacenamiento de la plataforma. |
SaveData
| Método | Retorno | Finalidad |
|---|
SaveData.Write(key, value) | booleano | Escribe un valor de cadena sin procesar avanzado. |
SaveData.Read(key) | cadena o nil | Lee un valor en bruto. |
SaveData.Delete(key) | boolean | Elimina una clave de la memoria; llama a Flush para guardar el cambio. Devuelve true aunque no exista. |
SaveData.Flush() | booleano | Guarda los datos en el dispositivo de almacenamiento de la plataforma. |
SaveData.Clear() | boolean | Borra de la memoria todas las entradas, tanto sin procesar como tipadas. |
SaveData.Reload() | booleano | Recarga los datos desde el dispositivo de almacenamiento de la plataforma. |
SaveData.GetLastError() | string | Lee el último fallo de persistencia. |
Identidad del engine
| Valor | Tipo | Finalidad |
|---|
Engine.Name | string | Nombre de implementación de tiempo de ejecución. |
Engine.ApiVersion | entero | Identificador de compatibilidad para el contrato de scripting instalado. |
Usa Flujo de trabajo de programación para el comportamiento de las herramientas y el código de bytes, y las páginas de temas para la configuración de componentes, ejemplos y restricciones específicas de PS1.
Para obtener información sobre el argumento exacto y las declaraciones de tipo retorno, incluidos todos los métodos de eje escalar, consulta el documento generado Referencia de la API.