docs - add context tags to interfaces and aux packages

This commit is contained in:
Cody Glassman 2025-06-16 16:32:51 -07:00
parent 132ff5294c
commit 21cf7bb397
16 changed files with 16 additions and 0 deletions

View File

@ -2,6 +2,7 @@
-- `openmw_aux.calendar` defines utility functions for formatting game time. -- `openmw_aux.calendar` defines utility functions for formatting game time.
-- Implementation can be found in `resources/vfs/openmw_aux/calendar.lua`. -- Implementation can be found in `resources/vfs/openmw_aux/calendar.lua`.
-- @module calendar -- @module calendar
-- @context global|menu|local
-- @usage local calendar = require('openmw_aux.calendar') -- @usage local calendar = require('openmw_aux.calendar')
local core = require('openmw.core') local core = require('openmw.core')

View File

@ -2,6 +2,7 @@
-- `openmw_aux.time` defines utility functions for timers. -- `openmw_aux.time` defines utility functions for timers.
-- Implementation can be found in `resources/vfs/openmw_aux/time.lua`. -- Implementation can be found in `resources/vfs/openmw_aux/time.lua`.
-- @module time -- @module time
-- @context global|menu|local
-- @usage local time = require('openmw_aux.time') -- @usage local time = require('openmw_aux.time')
local time = { local time = {

View File

@ -4,6 +4,7 @@ local ui = require('openmw.ui')
-- `openmw_aux.ui` defines utility functions for UI. -- `openmw_aux.ui` defines utility functions for UI.
-- Implementation can be found in `resources/vfs/openmw_aux/ui.lua`. -- Implementation can be found in `resources/vfs/openmw_aux/ui.lua`.
-- @module ui -- @module ui
-- @context menu|player
-- @usage local auxUi = require('openmw_aux.ui') -- @usage local auxUi = require('openmw_aux.ui')
local aux_ui = {} local aux_ui = {}

View File

@ -2,6 +2,7 @@
-- `openmw_aux.util` defines utility functions that are implemented in Lua rather than in C++. -- `openmw_aux.util` defines utility functions that are implemented in Lua rather than in C++.
-- Implementation can be found in `resources/vfs/openmw_aux/util.lua`. -- Implementation can be found in `resources/vfs/openmw_aux/util.lua`.
-- @module util -- @module util
-- @context global|menu|local
-- @usage local aux_util = require('openmw_aux.util') -- @usage local aux_util = require('openmw_aux.util')
local aux_util = {} local aux_util = {}

View File

@ -60,6 +60,7 @@ return {
interfaceName = 'Activation', interfaceName = 'Activation',
--- ---
-- @module Activation -- @module Activation
-- @context global
-- @usage require('openmw.interfaces').Activation -- @usage require('openmw.interfaces').Activation
interface = { interface = {
--- Interface version --- Interface version

View File

@ -58,6 +58,7 @@ return {
interfaceName = 'AI', interfaceName = 'AI',
--- Basic AI interface --- Basic AI interface
-- @module AI -- @module AI
-- @context local
-- @usage require('openmw.interfaces').AI -- @usage require('openmw.interfaces').AI
interface = { interface = {
--- Interface version --- Interface version

View File

@ -239,6 +239,7 @@ return {
interfaceName = 'Camera', interfaceName = 'Camera',
--- ---
-- @module Camera -- @module Camera
-- @context player
-- @usage require('openmw.interfaces').Camera -- @usage require('openmw.interfaces').Camera
interface = { interface = {
--- Interface version is 1 --- Interface version is 1

View File

@ -20,6 +20,7 @@ return {
--- ---
-- Allows to utilize built-in crime mechanics. -- Allows to utilize built-in crime mechanics.
-- @module Crimes -- @module Crimes
-- @context global
-- @usage require('openmw.interfaces').Crimes -- @usage require('openmw.interfaces').Crimes
interface = { interface = {
--- Interface version --- Interface version

View File

@ -6,6 +6,7 @@ return {
--- ---
-- Gamepad control interface -- Gamepad control interface
-- @module GamepadControls -- @module GamepadControls
-- @context player
-- @usage require('openmw.interfaces').GamepadControls -- @usage require('openmw.interfaces').GamepadControls
interface = { interface = {
--- Interface version --- Interface version

View File

@ -250,6 +250,7 @@ return {
interfaceName = 'Controls', interfaceName = 'Controls',
--- ---
-- @module Controls -- @module Controls
-- @context player
-- @usage require('openmw.interfaces').Controls -- @usage require('openmw.interfaces').Controls
interface = { interface = {
--- Interface version --- Interface version

View File

@ -60,6 +60,7 @@ return {
--- ---
-- Animation controller interface -- Animation controller interface
-- @module AnimationController -- @module AnimationController
-- @context local
-- @usage local anim = require('openmw.animation') -- @usage local anim = require('openmw.animation')
-- local I = require('openmw.interfaces') -- local I = require('openmw.interfaces')
-- --

View File

@ -46,6 +46,7 @@ local templatesMeta = {
--- ---
-- @module MWUI -- @module MWUI
-- @context menu|player
-- @usage require('openmw.interfaces').MWUI -- @usage require('openmw.interfaces').MWUI
local function TemplateOverrides(templates) local function TemplateOverrides(templates)
return setmetatable({ return setmetatable({

View File

@ -40,6 +40,7 @@ return {
interfaceName = 'Settings', interfaceName = 'Settings',
--- ---
-- @module Settings -- @module Settings
-- @context global|menu|player
-- @usage -- @usage
-- -- In a player script -- -- In a player script
-- local storage = require('openmw.storage') -- local storage = require('openmw.storage')

View File

@ -153,6 +153,7 @@ return {
--- ---
-- Allows to extend or override built-in skill progression mechanics. -- Allows to extend or override built-in skill progression mechanics.
-- @module SkillProgression -- @module SkillProgression
-- @context local
-- @usage local I = require('openmw.interfaces') -- @usage local I = require('openmw.interfaces')
-- --
-- -- Forbid increasing destruction skill past 50 -- -- Forbid increasing destruction skill past 50

View File

@ -159,6 +159,7 @@ return {
interfaceName = 'UI', interfaceName = 'UI',
--- ---
-- @module UI -- @module UI
-- @context player
-- @usage require('openmw.interfaces').UI -- @usage require('openmw.interfaces').UI
interface = { interface = {
--- Interface version --- Interface version

View File

@ -36,6 +36,7 @@ return {
-- * can't intercept actions performed by the AI (i.e. drinking a potion in combat); -- * can't intercept actions performed by the AI (i.e. drinking a potion in combat);
-- * can't intercept actions performed via quick keys menu. -- * can't intercept actions performed via quick keys menu.
-- @module ItemUsage -- @module ItemUsage
-- @context global
-- @usage local I = require('openmw.interfaces') -- @usage local I = require('openmw.interfaces')
-- --
-- -- Override Use action (global script). -- -- Override Use action (global script).