mirror of
https://github.com/OpenMW/openmw.git
synced 2025-06-28 15:41:35 +00:00
update the docs for land functions
This commit is contained in:
parent
8917103bf3
commit
378093791b
1 changed files with 20 additions and 16 deletions
|
@ -62,22 +62,6 @@
|
|||
-- @param #string setting Setting name
|
||||
-- @return #any
|
||||
|
||||
---
|
||||
-- Get the terrain height at a given location.
|
||||
-- @function [parent=#core] getHeightAt
|
||||
-- @param openmw.util#Vector3 position
|
||||
-- @param #any cellOrName (optional) cell or cell name in their exterior world space to query
|
||||
-- @return #number
|
||||
|
||||
---
|
||||
-- Get the terrain texture at a given location.
|
||||
-- @function [parent=#core] getLandTextureAt
|
||||
-- @param openmw.util#Vector3 position
|
||||
-- @param #any cellOrName (optional) cell or cell name in their exterior world space to query
|
||||
-- @return #nil, #number Land texture index or nil if failed to retrieve the texture
|
||||
-- @return #nil, #number Plugin id or nil if failed to retrieve the texture
|
||||
-- @return #nil, #string Texture path or nil if one isn't defined
|
||||
|
||||
---
|
||||
-- Return l10n formatting function for the given context.
|
||||
-- Localisation files (containing the message names and translations) should be stored in
|
||||
|
@ -466,10 +450,30 @@
|
|||
-- @usage for _, item in ipairs(inventory:findAll('common_shirt_01')) do ... end
|
||||
|
||||
|
||||
--- @{#Land}: Functions for interacting with land data
|
||||
-- @field [parent=#core] #Land land
|
||||
|
||||
|
||||
--- @{#Magic}: spells and spell effects
|
||||
-- @field [parent=#core] #Magic magic
|
||||
|
||||
|
||||
---
|
||||
-- Get the terrain height at a given location.
|
||||
-- @function [parent=#Land] getHeightAt
|
||||
-- @param openmw.util#Vector3 position
|
||||
-- @param #any cellOrName (optional) cell or cell name in their exterior world space to query
|
||||
-- @return #number
|
||||
|
||||
---
|
||||
-- Get the terrain texture at a given location.
|
||||
-- @function [parent=#Land] getLandTextureAt
|
||||
-- @param openmw.util#Vector3 position
|
||||
-- @param #any cellOrName (optional) cell or cell name in their exterior world space to query
|
||||
-- @return #nil, #number Land texture index or nil if failed to retrieve the texture
|
||||
-- @return #nil, #number Plugin id or nil if failed to retrieve the texture
|
||||
-- @return #nil, #string Texture path or nil if one isn't defined
|
||||
|
||||
--- Possible @{#SpellRange} values
|
||||
-- @field [parent=#Magic] #SpellRange RANGE
|
||||
|
||||
|
|
Loading…
Reference in a new issue