LOTJ Lua API

• Index

Contents

• Global functions
• Class Timer

Modules

• area
• char_proto
• character
• clan
• core
• events
• exit
• furniture
• hyperwall
• obj_proto
• object
• planet
• room
• ship
• ship_template
• space_spawn
• starsystem
• structure
• timer

Topics

• Introduction
• Lua Basics
• Creating an lprog
• Before and After: Lylek Drone
• gptnpcs

Examples

• mixrmastr-bartender-droid.lua
• yatta-invisible-market.lua

Module timer

Functions for handling timers (running code after a delay)

Global functions

Class Timer

Global functions

Timer.registerTimer (delayMs, repeat, fn)

register a new timer. This returns a timer object which must the be started. For most usage in lua progs, Timer.run will be simpler to use.

Parameters:

• delayMs number the number of milliseconds to wait
• repeat boolean if true, the timer will continue firing every delayMs. If false, it will fire only once.
• fn function the function to run when the timer fires.

Returns:

Timer the newly registered timer

Usage:

Timer.registerTimer(1000, false, function()
  self:sayTo(ch, "Hello there, welcome to the room.")
end):start()

Timer.run (delayMs, fn)

Runs a function once after some delay.

Parameters:

• delayMs number The number of milliseconds to wait
• fn function The function to run

Returns:

Timer The timer object, in case you need to cancel it

Usage:

self:onSpeech("help", function(self, ch)
  -- Wait 3 seconds, then respond to the character.
  Timer.run(3000, function()
    self:sayTo(ch, "Oh, you can help me?")
    self:sayTo(ch, "I need ten pieces of nerf meat.")
  end)
end)

Class Timer

timer:cancel ()

cancel a timer object. This cancels a started timer. You can use this to abort a one-time timer or to end a repeating timer.

timer:start ()

start a timer object. This begins counting the timer down. It must be called on timers created with registerTimer.