Skip to main content

OOP Format

Follow this format for writing OOP code:

local Object = {}
Object.__index = Object

function Object.new(foo : number, bar : string)
    local self = setmetatable({}, Object) -- UNSEALED TABLE!!!

    self.Foo = foo
    self.Bar = bar

    self:Init()

    return self
end

function Object:Init()
    -- Initialization
    self:Method()
end

function Object:Method()
    -- ...
end

return Object

Things to note:

  • OOP is done best with metatables
  • __index is declared at the top, right alongside the class declaration
  • .new makes a variable of the top of that scope called self, which is an unsealed metatable
  • Using .new calls :Init() before returning self