BIS fnc kbSkip: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {{Function|Comments=" to "{{Function|Comments=")
(Add example and see also)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Skip a conversation started with [[BIS_fnc_kbTell]]. Currently played sentence will be finished. |DESCRIPTION=
____________________________________________________________________________________________


Description:
| [topicName, mission, wait] call [[BIS_fnc_kbSkip]] |SYNTAX=
Skip conversation. Currently played sentence will be finished


Parameter(s):
|p1= topicName: [[String]] or [[Object]] - either topic name or the person currently talking
_this select 0: STRING - Topic name
_this select 1 (Optional): STRING - container name (default: current mission ID)


Returns:
|p2= mission: [[String]] - (Optional, default [[missionName]])
NUMBER
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
|p3= wait: [[Boolean]] or [[Array]] or [[Number]]
 
| [[Boolean]] or [[Number]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_kbSkip]]; --> |SYNTAX=
|x1= <code>["topic1", "currentMission"] [[call]] [[BIS_fnc_kbSkip]];</code> |EXAMPLE1=
 
|p1= |PARAMETER1=
 
| |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code></code> |EXAMPLE1=
|x2= <code>[<nowiki/>[[player]]] [[call]] [[BIS_fnc_kbSkip]];</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |SEEALSO=
| [[BIS_fnc_kbTell]], [[Conversations]], [[:Category:Function Group: Conversations|Function Group: Conversations]] |SEEALSO=
 
}}
}}



Revision as of 21:19, 5 January 2020

Hover & click on the images for description

Description

Description:
Skip a conversation started with BIS_fnc_kbTell. Currently played sentence will be finished.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[topicName, mission, wait] call BIS_fnc_kbSkip
Parameters:
topicName: String or Object - either topic name or the person currently talking
mission: String - (Optional, default missionName)
wait: Boolean or Array or Number
Return Value:
Boolean or Number

Examples

Example 1:
["topic1", "currentMission"] call BIS_fnc_kbSkip;
Example 2:
[player] call BIS_fnc_kbSkip;

Additional Information

See also:
BIS_fnc_kbTellConversationsFunction Group: Conversations

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

Notes

Bottom Section