Godot Lua PluginScript

• Index

Contents

• Functions

Modules

• Enumerations
• GD
• Globals
• LuaObject
• LuaScript
• LuaScriptInstance
• OOP
• math_extras
• package_extras
• property
• signal
• string_extras

Scripts

• lps_coroutine.lua

Classes

• AABB
• Array
• Basis
• Color
• Dictionary
• NodePath
• Object
• Plane
• PoolByteArray
• PoolColorArray
• PoolIntArray
• PoolRealArray
• PoolStringArray
• PoolVector2Array
• PoolVector3Array
• Quat
• Rect2
• RID
• String
• StringName
• Transform
• Transform2D
• Variant
• Vector2
• Vector3

Topics

• CHANGELOG
• README
• building
• configuring
• from-gdscript-to-lua
• limitations
• luarocks
• plugin

Examples

• lps_coroutine.lua
• lua_repl.lua

Module math_extras

Extra functionality for Lua's math library.

Functions

math.clamp (x, min, max)	Returns the value x clamped between an upper (max) and lower bounds (min).
math.lerp (from, to, amount)	Linearly interpolates values from and to by amount.

Functions

math.clamp (x, min, max)

Returns the value x clamped between an upper (max) and lower bounds (min). Any values comparable by order, that is, with a less than operator, can be passed in.

Parameters:

• x Vector2, Vector3, Color or number
• min Vector2, Vector3, Color or number
• max Vector2, Vector3, Color or number

Returns:

Vector2, Vector3, Color or number

math.lerp (from, to, amount)

Linearly interpolates values from and to by amount. Equivalent to from + (amount * (to - from)).

Parameters:

• from Vector2, Vector3, Color, Quat or number
• to Vector2, Vector3, Color, Quat or number
• amount number

Returns:

Vector2, Vector3, Color, Quat or number