mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-10-14 18:56:36 +00:00
Code Issues Releases Wiki Activity

CLEANUP: Document addTopic

Browse source
This commit is contained in:
Dave Corley 2025-09-14 14:38:05 -05:00
parent fbb726cee0
commit 9a4db2d65f
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1224,6 +1224,16 @@
-- @usage -- Start a new quest, add it to the player's quest list but don't add any journal entries -- @usage -- Start a new quest, add it to the player's quest list but don't add any journal entries
-- types.Player.quests(player)["ms_fargothring"].stage = 0 -- types.Player.quests(player)["ms_fargothring"].stage = 0
---
-- Adds a topic to the list of ones known by the player, so that it can be used in dialogue with actors who can talk about that topic.
-- @function [parent=#PLAYER] addTopic
-- @param openmw.core#GameObject player
-- @param string topicId
-- @usage -- Add topic to the list of known ones, in a player script
-- self.type.addTopic(self, "Some Work")
-- @usage -- Give all players in the current world a specific topic, in a global script
-- for _, player in ipairs(world.players) do player.type.addTopic(player, "Some Unrelated Work") end
--- ---
-- Returns @{#PlayerJournal}, which contains the read-only access to journal text data accumulated by the player. -- Returns @{#PlayerJournal}, which contains the read-only access to journal text data accumulated by the player.
-- Not the same as @{openmw_core#Dialogue.journal} which holds raw game records: with placeholders for dynamic variables and no player-specific info. -- Not the same as @{openmw_core#Dialogue.journal} which holds raw game records: with placeholders for dynamic variables and no player-specific info.