Godot Lua PluginScript

• Index

Contents

• Methods
• Metamethods

Classes

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

Modules

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

Scripts

• lps_coroutine.lua

Topics

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

Examples

• lps_coroutine.lua
• lua_repl.lua

Class RID

RID metatype, wrapper for godot_rid.

Construct using the idiom RID(from), which calls __new.

Methods

RID:get_id ()

Returns the ID of the referenced resource.

Metamethods

RID:__concat (a, b)	Concatenates values.
RID:__eq (a, b)	Equality comparison (a == b).
RID:__lt (a, b)	Less than comparison (a < b).
RID:__new ([from])	RID constructor, called by the idiom RID(from).
RID:__tostring ()	Returns a Lua string representation of this RID.

Methods

RID:get_id ()

Returns the ID of the referenced resource.

Returns:

int

Metamethods

RID:__concat (a, b)

Concatenates values.

Parameters:

• a First value, stringified with GD.str
• b First value, stringified with GD.str

Returns:

String

RID:__eq (a, b)

Equality comparison (a == b). If either a or b are not RIDs, always return false.

Parameters:

• a
• b

Returns:

bool

RID:__lt (a, b)

Less than comparison (a < b).

Parameters:

• a
• b

Returns:

bool

RID:__new ([from])

RID constructor, called by the idiom RID(from).

Parameters:

• from (optional)

Returns:

RID

RID:__tostring ()

Returns a Lua string representation of this RID.

Returns:

string