Gammon Forum

function Button:new (enabled, icon, tooltip, send, cooldown, sound)

  self.enabled = enabled,  -- displays only when enabled
  self.icon = icon,        -- icon image
  self.tooltip = tooltip,  -- tooltip help text
  self.send = send,        -- what to send
  self.cooldown = cooldown,-- cooldown time in seconds
  self.sound = sound,      -- sound to play when cast
  local Enable = function ()
     self.enabled = true
  end
  local Disable = function ()
     self.enabled = false
  end
end

MyClass = {
   hotspot_map = {}  -- we need this if we want to have miniwindow hotspots bound to our class instances, because hotspot callbacks can't invoke a specific instance
   -- global class variables go here
}
MyClass_defaults = {
   -- default instance variables go here
}
MyClass_meta = { __index = MyClass }


-- call MyClass.new() to get a new instance of MyClass
function MyClass.new()
   new_instance = setmetatable(copytable.deep(MyClass_defaults), MyClass_meta)
   -- you could also assign default instance variables here instead of in MyClass_defaults as well as assign custom ones by passing arguments into new
   return new_instance
end


-- call some_instance:functionCalledOnInstance() to do this for a particular instance
function MyClass:functionCalledOnInstance()
   -- this function has a `self` variable that refers to the instance
end


-- call some_instance:bindHotspot(hotspot_id) to bind a miniwindow hotspot to a particular class instance for callbacks
function MyClass:bindHotspot(hotspot_id)
   MyClass.hotspot_map[hotspot_id] = self
end


-- "MyClass.hotspotCallbackFunction" can be assigned as a miniwindow hotspot callback
function MyClass.hotspotCallbackFunction(flags, hotspot_id)
   -- this function does not have a `self` variable, so we retrieve the instance from the class hotspot map
   local some_instance = MyClass.hotspot_map[hotspot_id]
   -- now you can do stuff with some_instance after a hotspot callback
end