Referencia de la API de Lua
Consulta las funciones, los argumentos, los valores de retorno y las constantes disponibles en Polygon Engine 0.1.0-ea.21. Los nombres distinguen entre mayúsculas y minúsculas.
Los parámetros opcionales contienen ?; argumentos separados de punto y coma o múltiples valores de retorno. Las tablas Vec3 usan x, y y z. Las constantes de Input son proporcionadas por el tiempo de ejecución; no inferir sus máscaras de bits de un marcador de posición de declaración.
Comienza con Resumen de la API para elegir una función o abre su página de tema para obtener ejemplos y orientación sobre el uso. Agrega callbacks del ciclo de vida a un Lua Behaviour; el motor los llama en la etapa correspondiente del juego.
Callbacks del ciclo de vida
| Devolución de llamada | Parámetros |
|---|
Awake | gameObjectId: integer |
OnEnable | gameObjectId: integer |
Start | gameObjectId: integer |
FixedUpdate | gameObjectId: integer; fixedDeltaTime: number |
Update | gameObjectId: integer; deltaTime: number |
LateUpdate | gameObjectId: integer; deltaTime: number |
OnCollisionEnter | gameObjectId: integer; otherGameObjectId: integer |
OnCollisionStay | gameObjectId: integer; otherGameObjectId: integer |
OnCollisionExit | gameObjectId: integer; otherGameObjectId: integer |
OnTriggerEnter | gameObjectId: integer; otherGameObjectId: integer |
OnTriggerStay | gameObjectId: integer; otherGameObjectId: integer |
OnTriggerExit | gameObjectId: integer; otherGameObjectId: integer |
OnDisable | gameObjectId: integer |
OnDestroy | gameObjectId: integer |
Session
| Método | Parámetros | Retorno |
|---|
Session.Read | key: string | string|nil |
Session.Write | key: string; value: string | boolean |
Session.Delete | key: string | boolean |
ScreenFade
| Método | Parámetros | Retorno |
|---|
ScreenFade.ToBlack | seconds?: number | boolean |
ScreenFade.FromBlack | seconds?: number | boolean |
ScreenFade.IsPlaying | ninguno | boolean |
| Método | Parámetros | Retorno |
|---|
UI.SetInputEnabled | enabled: boolean | boolean |
UI.SetSubmitButton | buttonOrAction: string | boolean |
UI.SetSelectionColor | r: integer; g: integer; b: integer | boolean |
UI.Find | name: string | integer |
UI.GetType | elementId: integer | integer|nil |
UI.GetCount | ninguno | integer |
UI.DrawText | x: number; y: number; text: string | ninguno |
Canvas
| Método | Parámetros | Retorno |
|---|
Canvas.SetModal | canvasId: integer | boolean |
Canvas.Find | name: string | integer |
Canvas.SetEnabled | canvasId: integer; enabled: boolean | boolean |
Canvas.IsEnabled | canvasId: integer | boolean |
Canvas.SetSortOrder | canvasId: integer; sortOrder: integer | boolean |
Canvas.GetCount | ninguno | integer |
Log
| Método | Parámetros | Retorno |
|---|
Log.Print | message: any | ninguno |
Time
| Método | Parámetros | Retorno |
|---|
Time.DeltaTime | ninguno | number |
Time.UnscaledDeltaTime | ninguno | number |
Time.GetTimeScale | ninguno | number |
Time.SetTimeScale | scale: number | boolean |
| Método | Parámetros | Retorno |
|---|
Transform.GetPosition | gameObjectId: integer | Vec3|nil |
Transform.SetPosition | gameObjectId: integer; positionOrX: Vec3|number; y?: number; z?: number | boolean |
Transform.GetPositionX | gameObjectId: integer | number|nil |
Transform.GetPositionY | gameObjectId: integer | number|nil |
Transform.GetPositionZ | gameObjectId: integer | number|nil |
Transform.GetRotation | gameObjectId: integer | Vec3|nil |
Transform.SetRotation | gameObjectId: integer; rotationOrX: Vec3|number; y?: number; z?: number | boolean |
Transform.GetRotationX | gameObjectId: integer | number|nil |
Transform.GetRotationY | gameObjectId: integer | number|nil |
Transform.GetRotationZ | gameObjectId: integer | number|nil |
Transform.GetScale | gameObjectId: integer | Vec3|nil |
Transform.SetScale | gameObjectId: integer; scaleOrX: Vec3|number; y?: number; z?: number | boolean |
Transform.GetScaleX | gameObjectId: integer | number|nil |
Transform.GetScaleY | gameObjectId: integer | number|nil |
Transform.GetScaleZ | gameObjectId: integer | number|nil |
Transform.RotateX | gameObjectId: integer; degrees: number | boolean |
Transform.RotateY | gameObjectId: integer; degrees: number | boolean |
Transform.RotateZ | gameObjectId: integer; degrees: number | boolean |
Transform.Translate | gameObjectId: integer; x: number; y: number; z: number | boolean |
GameObject
| Método | Parámetros | Retorno |
|---|
GameObject.Find | name: string | integer |
GameObject.Exists | gameObjectId: integer | boolean |
GameObject.GetName | gameObjectId: integer | string|nil |
GameObject.IsActive | gameObjectId: integer | boolean|nil |
GameObject.SetActive | gameObjectId: integer; active: boolean | boolean |
GameObject.Invoke | gameObjectId: integer; functionName: string; integerArg1?: integer; integerArg2?: integer; stringArg1?: string; stringArg2?: string | boolean |
GameObject.CompareTag | gameObjectId: integer; tag: string | boolean |
GameObject.GetLayer | gameObjectId: integer | integer |
GameObject.SetLayer | gameObjectId: integer; layer: integer | boolean |
| Método | Parámetros | Retorno |
|---|
Input.GetButton | buttonOrAction: integer|string | boolean |
Input.GetButtonDown | buttonOrAction: integer|string | boolean |
Input.GetButtonUp | buttonOrAction: integer|string | boolean |
Input.GetAxis | stickOrAction?: integer|string; deadZone?: number | number; number |
Input.IsConnected | ninguno | boolean |
Input.HasAnalog | ninguno | boolean |
Input.GetPadType | ninguno | integer |
| Valor nombrado | Tipo |
|---|
Input.CROSS | integer |
Input.CIRCLE | integer |
Input.SQUARE | integer |
Input.TRIANGLE | integer |
Input.UP | integer |
Input.DOWN | integer |
Input.LEFT | integer |
Input.RIGHT | integer |
Input.START | integer |
Input.SELECT | integer |
Input.L1 | integer |
Input.L2 | integer |
Input.L3 | integer |
Input.R1 | integer |
Input.R2 | integer |
Input.R3 | integer |
Input.STICK_LEFT | integer |
Input.STICK_RIGHT | integer |
| Método | Parámetros | Retorno |
|---|
PlayerInput.SetEnabled | gameObjectId: integer; enabled: boolean | boolean |
PlayerInput.IsEnabled | gameObjectId: integer | boolean|nil |
Rumble
| Método | Parámetros | Retorno |
|---|
Rumble.Play | lowFrequency?: number; highFrequency?: number; durationSeconds?: number | boolean |
Rumble.Stop | ninguno | none |
Rumble.IsSupported | ninguno | boolean |
AudioSource
| Método | Parámetros | Retorno |
|---|
AudioSource.Play | gameObjectId: integer | boolean |
AudioSource.PlayOneShot | gameObjectId: integer | boolean |
AudioSource.Stop | gameObjectId: integer | boolean |
AudioSource.SetVolume | gameObjectId: integer; volume: number | boolean |
AudioSource.SetPan | gameObjectId: integer; pan: number | boolean |
AudioSource.IsPlaying | gameObjectId: integer | boolean |
Music
| Método | Parámetros | Retorno |
|---|
Music.Play | name: string; loop?: boolean | boolean |
Music.Stop | ninguno | boolean |
Music.SetVolume | volume: number | boolean |
Music.IsPlaying | ninguno | boolean |
Camera
| Método | Parámetros | Retorno |
|---|
Camera.Has | gameObjectId: integer | boolean |
Camera.GetActive | ninguno | integer |
Camera.GetFieldOfView | gameObjectId: integer | number|nil |
Camera.SetFieldOfView | gameObjectId: integer; degrees: number | boolean |
Light
| Método | Parámetros | Retorno |
|---|
Light.Has | gameObjectId: integer | boolean |
Light.GetDirection | gameObjectId: integer | Vec3|nil |
Light.SetDirection | gameObjectId: integer; x: number; y: number; z: number | boolean |
Light.GetColor | gameObjectId: integer | ColorRgb|nil |
Light.SetColor | gameObjectId: integer; r: integer; g: integer; b: integer | boolean |
Light.GetIntensity | gameObjectId: integer | number|nil |
Light.SetIntensity | gameObjectId: integer; intensity: number | boolean |
Light.GetAmbient | gameObjectId: integer | ColorRgb|nil |
Light.SetAmbient | gameObjectId: integer; r: integer; g: integer; b: integer | boolean |
Collider
| Método | Parámetros | Retorno |
|---|
Collider.Has | gameObjectId: integer | boolean |
Collider.GetShape | gameObjectId: integer | integer|nil |
Collider.SetShape | gameObjectId: integer; shape: integer | boolean |
Collider.IsTrigger | gameObjectId: integer | boolean |
Collider.SetIsTrigger | gameObjectId: integer; isTrigger: boolean | boolean |
Collider.GetSize | gameObjectId: integer | Vec3|nil |
Collider.SetSize | gameObjectId: integer; x: number; y: number; z: number | boolean |
Collider.GetRadius | gameObjectId: integer | number|nil |
Collider.SetRadius | gameObjectId: integer; radius: number | boolean |
| Valor nombrado | Tipo |
|---|
Collider.ShapeBox | integer |
Collider.ShapeSphere | integer |
Physics
| Método | Parámetros | Retorno |
|---|
Physics.IsColliding | gameObjectId: integer; otherGameObjectId?: integer | boolean |
Physics.GetCollisionCount | gameObjectId: integer | integer |
Physics.Raycast | originX: number; originY: number; originZ: number; directionX: number; directionY: number; directionZ: number; maxDistance: number; layerMask?: integer; queryTriggers?: boolean | boolean; integer; number; number; number; number; number; number; number |
SceneManager
| Método | Parámetros | Retorno |
|---|
SceneManager.LoadScene | scenePath: string; options?: table | boolean |
SceneManager.GetEntryPoint | ninguno | string |
Timeline
| Método | Parámetros | Retorno |
|---|
Timeline.Play | name: string; options?: { OnComplete: fun() } | boolean |
Timeline.Stop | ninguno | none |
Timeline.IsPlaying | ninguno | boolean |
Animation
| Método | Parámetros | Retorno |
|---|
Animation.Play | name: string; loopOrOptions?: boolean|{ Loop: boolean, OnComplete: fun() } | boolean |
Animation.Stop | name?: string | ninguno |
Animation.IsPlaying | name?: string | boolean |
NavMesh
| Método | Parámetros | Retorno |
|---|
NavMesh.FindPath | startX: number; startY: number; startZ: number; endX: number; endY: number; endZ: number | table |
NavMesh.SamplePosition | x: number; y: number; z: number; maxDistance: number; surfaceGameObjectId?: integer | boolean; number; number; number |
NavMeshAgent
| Método | Parámetros | Retorno |
|---|
NavMeshAgent.SetDestination | gameObjectId: integer; x: number; y: number; z: number | boolean |
NavMeshAgent.Stop | gameObjectId: integer | ninguno |
NavMeshAgent.IsMoving | gameObjectId: integer | boolean |
NavMeshAgent.HasPath | gameObjectId: integer | boolean |
NavMeshAgent.HasReachedDestination | gameObjectId: integer | boolean |
NavMeshAgent.IsOnNavMesh | gameObjectId: integer | boolean |
NavMeshAgent.GetRemainingDistance | gameObjectId: integer | number |
NavMeshAgent.GetSpeed | gameObjectId: integer | number |
NavMeshAgent.GetPathStatus | gameObjectId: integer | integer |
| Valor nombrado | Tipo |
|---|
NavMeshAgent.PathInvalid | integer |
NavMeshAgent.PathComplete | integer |
Portal
| Método | Parámetros | Retorno |
|---|
Portal.SetOpen | portalGameObjectId: integer; open: boolean | boolean |
Text
| Método | Parámetros | Retorno |
|---|
Text.SetVisibleCharacterCount | elementId: integer; count: integer | boolean |
Text.GetVisibleCharacterCount | elementId: integer | integer|nil |
Text.SetColor | elementId: integer; r: integer; g: integer; b: integer; a?: integer | boolean |
Text.GetColor | elementId: integer | integer|nil; integer|nil; integer|nil; integer|nil |
Text.SetText | elementId: integer; text: string | boolean |
Text.GetText | elementId: integer | string|nil |
| Método | Parámetros | Retorno |
|---|
RectTransform.SetScale | elementId: integer; x: number; y: number | boolean |
RectTransform.GetScale | elementId: integer | number|nil; number|nil |
RectTransform.SetPosition | elementId: integer; x: number; y: number | boolean |
RectTransform.GetPosition | elementId: integer | number|nil; number|nil |
RectTransform.SetSize | elementId: integer; width: number; height: number | boolean |
RectTransform.GetSize | elementId: integer | number|nil; number|nil |
Image
| Método | Parámetros | Retorno |
|---|
Image.SetTexture | elementId: integer; textureGuid: string | boolean |
Image.GetTexture | elementId: integer | string|nil |
| Método | Parámetros | Retorno |
|---|
Button.SetInteractable | elementId: integer; interactable: boolean | boolean |
Button.IsInteractable | elementId: integer | boolean |
Graphic
| Método | Parámetros | Retorno |
|---|
Graphic.SetColor | elementId: integer; r: integer; g: integer; b: integer; a?: integer | boolean |
Graphic.GetColor | elementId: integer | integer|nil; integer|nil; integer|nil; integer|nil |
Graphic.SetEnabled | elementId: integer; enabled: boolean | boolean |
Graphic.IsEnabled | elementId: integer | boolean |
Selectable
| Método | Parámetros | Retorno |
|---|
Selectable.Select | elementId: integer | boolean |
Selectable.GetSelected | ninguno | integer |
ProgressBar
| Método | Parámetros | Retorno |
|---|
ProgressBar.SetValue | elementId: integer; value: number | boolean |
ProgressBar.GetValue | elementId: integer | number|nil |
Interactable
| Método | Parámetros | Retorno |
|---|
Interactable.SetEnabled | gameObjectId: integer; enabled: boolean | boolean |
Interactable.IsEnabled | gameObjectId: integer | boolean |
| Método | Parámetros | Retorno |
|---|
TransformAnimator.Play | gameObjectId: integer; state?: string | boolean |
TransformAnimator.Stop | gameObjectId: integer | boolean |
TransformAnimator.SetSpeed | gameObjectId: integer; speed: number | boolean |
TransformAnimator.IsPlaying | gameObjectId: integer | boolean |
TransformAnimator.SetState | gameObjectId: integer; state: string | boolean |
TransformAnimator.GetState | gameObjectId: integer | string|nil |
Animator
| Método | Parámetros | Retorno |
|---|
Animator.Play | gameObjectId: integer; clipName: string; loop?: boolean | boolean |
Animator.Stop | gameObjectId: integer | boolean |
Animator.IsPlaying | gameObjectId: integer | boolean |
Animator.GetClip | gameObjectId: integer | string|nil |
Animator.ConsumeFinished | gameObjectId: integer | string|nil |
PlayerPrefs
| Método | Parámetros | Retorno |
|---|
PlayerPrefs.SetInt | key: string; value: integer | boolean |
PlayerPrefs.GetInt | key: string; defaultValue?: integer | integer |
PlayerPrefs.SetFloat | key: string; value: number | boolean |
PlayerPrefs.GetFloat | key: string; defaultValue?: number | number |
PlayerPrefs.SetString | key: string; value: string | boolean |
PlayerPrefs.GetString | key: string; defaultValue?: string | string |
PlayerPrefs.HasKey | key: string | boolean |
PlayerPrefs.DeleteKey | key: string | boolean |
PlayerPrefs.DeleteAll | ninguno | boolean |
PlayerPrefs.Save | ninguno | boolean |
SaveData
| Método | Parámetros | Retorno |
|---|
SaveData.Write | key: string; value: string | boolean |
SaveData.Read | key: string | string|nil |
SaveData.Delete | key: string | boolean |
SaveData.Flush | ninguno | boolean |
SaveData.Clear | ninguno | boolean |
SaveData.Reload | ninguno | boolean |
SaveData.GetLastError | ninguno | string |
ParticleSystem
| Método | Parámetros | Retorno |
|---|
ParticleSystem.Emit | x: number; y: number; z: number; velocityX: number; velocityY: number; velocityZ: number; lifetime: number; r?: integer; g?: integer; b?: integer | ninguno |
ParticleSystem.Clear | ninguno | none |
CharacterController
| Método | Parámetros | Retorno |
|---|
CharacterController.Move | gameObjectId: integer; x: number; y: number; z: number | boolean |
CharacterController.IsGrounded | gameObjectId: integer | boolean |
CharacterController.GetVelocityY | gameObjectId: integer | number |
CharacterController.SetVelocityY | gameObjectId: integer; velocity: number | boolean |
Engine
| Valor nombrado | Tipo |
|---|
Engine.Name | string |
Engine.ApiVersion | integer |