Class

#lib.class

Create a new class definition with optional inheritance.

lua
local Animal = lib.class('Animal')

function Animal:constructor(name, sound)
    self.name = name
    self.private.sound = sound  -- private field
end

function Animal:speak()
    return self.name .. ' says ' .. self.private.sound
end

local dog = Animal:new('Rex', 'Woof')
print(dog:speak()) -- "Rex says Woof"

#Signature

lua
local MyClass = lib.class(name, super)

#Inheritance

lua
local Dog = lib.class('Dog', Animal)

function Dog:constructor(name)
    self:super(name, 'Woof')  -- call parent constructor
end

function Dog:fetch(item)
    return self.name .. ' fetches the ' .. item
end

#Type Checking

lua
lib.isClass(dog)            -- true
lib.instanceOf(dog, Animal) -- true
lib.instanceOf(dog, Dog)    -- true

#Private Fields

Fields stored on self.private are only accessible from within the class methods. External access will error.

lua
print(dog.private.sound)  -- errors: cannot access private field