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 string_extras

Extra functionality for Lua's string library.

Functions

string.join (sep, ...)	Returns a Lua string with all values joined by separator.
string.quote (value)	Quote a value, alias for string.format("%q", tostring(value)).
string.replace (str, pattern, replacement)	Performs plain substring substitution, with no characters in pattern or replacement being considered magic.

Functions

string.join (sep, ...)

Returns a Lua string with all values joined by separator. tostring is called to each of the passed values before joining.

Parameters:

• sep string
• ... Values to be joined, stringified by tostring.

Returns:

string

Usage:

assert(string.join(',', 1, 2, 'three', Array()) == '1,2,three,[]')

string.quote (value)

Quote a value, alias for string.format("%q", tostring(value)).

Parameters:

• value

Returns:

string

string.replace (str, pattern, replacement)

Performs plain substring substitution, with no characters in pattern or replacement being considered magic.

Parameters:

• str string
• pattern string
• replacement string

Returns:

string

See also:

string.gsub

Usage:

assert(string.replace('Dot.percent.arent.magic', '.', '%') == 'Dot%percent%arent%magic')