lclass icon indicating copy to clipboard operation
lclass copied to clipboard

Class-based object-oriented programming in Lua

lclass

Lua with Classes

Usage

Creating a class

class("amphibian")

...or

class "amphibian"

...or with inheritance

-- inherit from existing class "animal"
class "amphibian" ("animal")

Creating a constructor

function amphibian:amphibian()
	-- call the base class constructor
	animal.animal(self)
	self.kingdom = "Animalia"
	self.class = "Amphibia"
end

Creating methods

function amphibian:swim()
	print("Splash!")
end

Creating metamethods

function amphibian:__tostring()
	return "amphibian: " .. self.class
end

Creating an instance of a class

local a = amphibian()

Creating a garbage-collection metamethod

function amphibian:amphibian()
	setproxy(self)
end

function amphibian:__gc()
	-- ...
end

License

MIT License

Copyright (c) 2020 Andrew McWatters

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.