BIS fnc kbTopicConfig: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (Text replacement - "{{Feature | Informative | " to "{{Feature|informative|")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| tkoh |Game name=
|game1= tkoh
|version1= 1.00


|1.00|Game version=
|game2= arma3
____________________________________________________________________________________________
|version2= 0.50


| Reads the [[Config|configs]] to return a matching <tt>CfgSentences</tt> config entry (in that order: [[configFile]], [[campaignConfigFile]], [[missionConfigFile]]).
|gr1= Conversations
{{note | This function is intended to be used by [[BIS_fnc_kbTell]] only.}} |DESCRIPTION=
____________________________________________________________________________________________


| [mission, topic] call [[BIS_fnc_kbTopicConfig]] |SYNTAX=
|descr= Reads the [[Config|configs]] to return a matching {{hl|config [[config greater greater name|&gt;&gt;]] [[Description.ext#CfgSentences|CfgSentences]] [[config greater greater name|&gt;&gt;]] missionName [[config greater greater name|&gt;&gt;]] topic}} entry.
{{Feature|informative|[[Config]]s are checked in that order: [[configFile]], [[campaignConfigFile]], [[missionConfigFile]].}}
{{Feature | important | This function is intended to be used by [[BIS_fnc_kbTell]] only.}}


|p1= mission: [[String]] |PARAMETER1=
|s1= [missionName, topic] call [[BIS_fnc_kbTopicConfig]]


|p2= topic: [[String]] |PARAMETER2=
|p1= missionName: [[String]]


| [[Config]] - [[nil]] on error or not found |RETURNVALUE=
|p2= topic: [[String]]
____________________________________________________________________________________________


|x1= <code>["missionName", "topic"] [[call]] [[BIS_fnc_kbTopicConfig]];</code> |EXAMPLE1=
|r1= [[Config]] - the topic's config entry. [[nil]] on error or not found
____________________________________________________________________________________________


| [[Conversations]] [[BIS_fnc_kbTell]] |SEEALSO=
|x1= <sqf>private _configTopic = ["missionName", "topic"] call BIS_fnc_kbTopicConfig;</sqf>
 
|seealso= [[Conversations]] [[BIS_fnc_kbTell]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:{{Name|arma3}}: Functions|{{uc:kbTopicConfig}}]]
[[Category:Function Group: Conversations|{{uc:kbTopicConfig}}]]

Latest revision as of 21:41, 16 May 2024

Hover & click on the images for description

Description

Description:
Reads the configs to return a matching config >> CfgSentences >> missionName >> topic entry.
This function is intended to be used by BIS_fnc_kbTell only.
Execution:
call
Groups:
Conversations

Syntax

Syntax:
[missionName, topic] call BIS_fnc_kbTopicConfig
Parameters:
missionName: String
topic: String
Return Value:
Config - the topic's config entry. nil on error or not found

Examples

Example 1:
private _configTopic = ["missionName", "topic"] call BIS_fnc_kbTopicConfig;

Additional Information

See also:
Conversations BIS_fnc_kbTell

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note