mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-12-01 01:04:30 +00:00
Code Issues Releases Wiki Activity

Added documentation.

Browse source
This commit is contained in:
Nova 2025-11-12 22:29:16 -05:00 committed by Alexei Kotov
parent dcbda0cbaa
commit 5a76783616
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
files/lua_api/openmw/types.lua
View file

@ -1088,6 +1088,17 @@
-- @param openmw.core#GameObject actor -- @param openmw.core#GameObject actor
-- @return #boolean -- @return #boolean
---
-- Turn an NPC or player into werewolf form or back to normal form.
-- Can only be used in global scripts or on self in local scripts.
-- @function [parent=#NPC] setWerewolf
-- @param openmw.core#GameObject actor The NPC or player to transform
-- @param #boolean werewolf True to transform into werewolf, false to transform back to normal
-- @usage -- Transform player into werewolf in a global script
-- types.NPC.setWerewolf(player, true)
-- @usage -- Transform self back to normal in a local script
-- types.NPC.setWerewolf(self, false)
--- ---
-- Returns the read-only @{#NpcRecord} of an NPC -- Returns the read-only @{#NpcRecord} of an NPC
-- @function [parent=#NPC] record -- @function [parent=#NPC] record