1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-06-29 15:11:35 +00:00

Merge branch 'docs-mwscript-variables' into 'master'

Fix MWScript variables documentation type

See merge request OpenMW/openmw!3572
This commit is contained in:
Zackhasacat 2023-11-08 16:28:52 +00:00
commit 279e9affa8

View file

@ -22,6 +22,10 @@
-- Functions related to MWScript.
-- @type MWScriptFunctions
---
-- @type MWScriptVariables
-- @map <#string, #number>
---
-- Returns local mwscript on ``object``. Returns `nil` if the script doesn't exist or is not started.
-- @function [parent=#MWScriptFunctions] getLocalScript
@ -33,7 +37,7 @@
-- Returns mutable global variables. In multiplayer, these may be specific to the provided player.
-- @function [parent=#MWScriptFunctions] getGlobalVariables
-- @param openmw.core#GameObject player (optional) Will be used in multiplayer mode to get the globals if there is a separate instance for each player. Currently has no effect.
-- @return #list<#number>
-- @return #MWScriptVariables
---
-- Returns global mwscript with given recordId. Returns `nil` if the script doesn't exist or is not started.