mirror of https://github.com/OpenMW/openmw.git
Change terminology of gameSecond/gameHour to simulationTime/gameTime
Petr Mikheev
2 years ago
parent
8ee8f81619
commit
2d1b100239
@ -0,0 +1,5 @@
|
||||
Package openmw_aux.time
|
||||
=======================
|
||||
|
||||
.. raw:: html
|
||||
:file: generated_html/openmw_aux_time.html
|
||||
@ -0,0 +1,104 @@
|
||||
---
|
||||
-- `openmw_aux.time` defines utility functions for timers.
|
||||
-- Implementation can be found in `resources/vfs/openmw_aux/time.lua`.
|
||||
-- @module time
|
||||
-- @usage local time = require('openmw_aux.time')
|
||||
|
||||
local time = {
|
||||
second = 1,
|
||||
minute = 60,
|
||||
hour = 3600,
|
||||
day = 3600 * 24,
|
||||
GameTime = 'GameTime',
|
||||
SimulationTime = 'SimulationTime',
|
||||
}
|
||||
|
||||
---
|
||||
-- Alias of async:registerTimerCallback ; register a function as a timer callback.
|
||||
-- @function [parent=#time] registerTimerCallback
|
||||
-- @param #string name
|
||||
-- @param #function func
|
||||
-- @return openmw.async#TimerCallback
|
||||
function time.registerTimerCallback(name, fn)
|
||||
local async = require('openmw.async')
|
||||
return async:registerTimerCallback(name, fn)
|
||||
end
|
||||
|
||||
---
|
||||
-- Alias of async:newSimulationTimer ; call callback(arg) in `delay` game seconds.
|
||||
-- Callback must be registered in advance.
|
||||
-- @function [parent=#time] newGameTimer
|
||||
-- @param #number delay
|
||||
-- @param openmw.async#TimerCallback callback A callback returned by `registerTimerCallback`
|
||||
-- @param arg An argument for `callback`; can be `nil`.
|
||||
function time.newGameTimer(delay, callback, callbackArg)
|
||||
local async = require('openmw.async')
|
||||
return async:newGameTimer(delay, callback, callbackArg)
|
||||
end
|
||||
|
||||
---
|
||||
-- Alias of async:newSimulationTimer ; call callback(arg) in `delay` simulation seconds.
|
||||
-- Callback must be registered in advance.
|
||||
-- @function [parent=#time] newSimulationTimer
|
||||
-- @param #number delay
|
||||
-- @param openmw.async#TimerCallback callback A callback returned by `registerTimerCallback`
|
||||
-- @param arg An argument for `callback`; can be `nil`.
|
||||
function time.newSimulationTimer(delay, callback, callbackArg)
|
||||
local async = require('openmw.async')
|
||||
return async:newSimulationTimer(delay, callback, callbackArg)
|
||||
end
|
||||
|
||||
---
|
||||
-- Run given function repeatedly.
|
||||
-- Note that loading a save stops the evaluation. If it should work always, call it during initialization of the script (i.e. not in a handler)
|
||||
-- @function [parent=#time] runRepeatedly
|
||||
-- @param #function fn the function that should be called
|
||||
-- @param #number period interval
|
||||
-- @param #table options additional options `initialDelay` and `type`.
|
||||
-- `initialDelay` - delay before the first call. If missed then the delay is a random number in range [0, N]. Randomization is used for performance reasons -- to prevent all scripts from doing time consuming operations at the same time.
|
||||
-- `type` - either `time.SimulationTime` (by default, timer uses simulation time) or `time.GameTime` (timer uses game time).
|
||||
-- @return #function a function without arguments that can be used to stop the periodical evaluation.
|
||||
-- @usage
|
||||
-- local stopFn = time.runRepeatedly(function() print('Test') end,
|
||||
-- 5 * time.second) -- print 'Test' every 5 seconds
|
||||
-- stopFn() -- stop printing 'Test'
|
||||
-- time.runRepeatedly( -- print 'Test' every 5 minutes with initial 30 second delay
|
||||
-- function() print('Test2') end, 5 * time.minute,
|
||||
-- { initialDelay = 30 * time.second })
|
||||
-- @usage
|
||||
-- local timeBeforeMidnight = time.day - time.gameTime() % time.day
|
||||
-- time.runRepeatedly(doSomething, time.day, {
|
||||
-- initialDelay = timeBeforeMidnight,
|
||||
-- type = time.GameTime,
|
||||
-- }) -- call `doSomething` at the end of every game day.
|
||||
function time.runRepeatedly(fn, period, options)
|
||||
if period <= 0 then
|
||||
error('Period must be positive. If you want it to be as small '..
|
||||
'as possible, use the engine handler `onUpdate` instead', 2)
|
||||
end
|
||||
local async = require('openmw.async')
|
||||
local core = require('openmw.core')
|
||||
local initialDelay = (options and options.initialDelay) or math.random() * period
|
||||
local getTimeFn, newTimerFn
|
||||
if (options and options.type) == time.GameTime then
|
||||
getTimeFn = core.getGameTime
|
||||
newTimerFn = async.newUnsavableGameTimer
|
||||
else
|
||||
getTimeFn = core.getSimulationTime
|
||||
newTimerFn = async.newUnsavableSimulationTimer
|
||||
end
|
||||
local baseTime = getTimeFn() + initialDelay
|
||||
local breakFlag = false
|
||||
local wrappedFn
|
||||
wrappedFn = function()
|
||||
if breakFlag then return end
|
||||
fn()
|
||||
local nextDelay = 1.5 * period - math.fmod(getTimeFn() - baseTime + period / 2, period)
|
||||
newTimerFn(async, nextDelay, wrappedFn)
|
||||
end
|
||||
newTimerFn(async, initialDelay, wrappedFn)
|
||||
return function() breakFlag = true end
|
||||
end
|
||||
|
||||
return time
|
||||
|
||||
@ -0,0 +1,64 @@
|
||||
-------------------------------------------------------------------------------
|
||||
-- Operating System Facilities.
|
||||
-- This library is implemented through table os.
|
||||
-- @module os
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
-- Returns a string or a table containing date and time, formatted according
|
||||
-- to the given string `format`.
|
||||
--
|
||||
-- If the `time` argument is present, this is the time to be formatted
|
||||
-- (see the `os.time` function for a description of this value). Otherwise,
|
||||
-- `date` formats the current time.
|
||||
--
|
||||
-- If `format` starts with '`!`', then the date is formatted in Coordinated
|
||||
-- Universal Time. After this optional character, if `format` is the string
|
||||
-- "`*t`", then `date` returns a table with the following fields:
|
||||
--
|
||||
-- * `year` (four digits)
|
||||
-- * `month` (1--12)
|
||||
-- * `day` (1--31)
|
||||
-- * `hour` (0--23)
|
||||
-- * `min` (0--59)
|
||||
-- * `sec` (0--61)
|
||||
-- * `wday` (weekday, Sunday is 1)
|
||||
-- * `yday` (day of the year)
|
||||
-- * `isdst` (daylight saving flag, a boolean).
|
||||
--
|
||||
-- If `format` is not "`*t`", then `date` returns the date as a string,
|
||||
-- formatted according to the same rules as the C function `strftime`.
|
||||
-- When called without arguments, `date` returns a reasonable date and time
|
||||
-- representation that depends on the host system and on the current locale
|
||||
-- (that is, `os.date()` is equivalent to `os.date("%c")`).
|
||||
-- @function [parent=#os] date
|
||||
-- @param #string format format of date. (optional)
|
||||
-- @param #number time time to format. (default value is current time)
|
||||
-- @return #string a formatted string representation of `time`.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
-- Returns the number of seconds from time `t1` to time `t2`. In POSIX,
|
||||
-- Windows, and some other systems, this value is exactly `t2`*-*`t1`.
|
||||
-- @function [parent=#os] difftime
|
||||
-- @param #number t2
|
||||
-- @param #number t1
|
||||
-- @return #number the number of seconds from time `t1` to time `t2`.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
-- Returns the current time when called without arguments, or a time
|
||||
-- representing the date and time specified by the given table. This table
|
||||
-- must have fields `year`, `month`, and `day`, and may have fields `hour`,
|
||||
-- `min`, `sec`, and `isdst` (for a description of these fields, see the
|
||||
-- `os.date` function).
|
||||
--
|
||||
-- The returned value is a number, whose meaning depends on your system. In
|
||||
-- POSIX, Windows, and some other systems, this number counts the number
|
||||
-- of seconds since some given start time (the "epoch"). In other systems,
|
||||
-- the meaning is not specified, and the number returned by `time` can be
|
||||
-- used only as an argument to `date` and `difftime`.
|
||||
-- @function [parent=#os] time
|
||||
-- @param #table table a table which describes a date.
|
||||
-- @return #number a number meaning a date.
|
||||
|
||||
return nil
|
||||
|
||||
Loading…
Reference in New Issue