BIS fnc kbTell

1.00

Hover & click on the images for description

Description

Description:

/*

	Description:
	Plays conversation. Script terminates itself when conversation is finished.

	Parameter(s):
	_this select 0: STRING - Topic name
	_this select 1 (Optional): STRING - container name (default: current mission ID)
	_this select 2 (Optional): ARRAY - section to be played. Elements can be:
		* STRING - "variant" - play specific variant
		* ARRAY
			* [startingSentence,(endingSentence)] - play al sentences between specific start and end
				startingSentence can be in format:
					* STRING - full sentence name (example: 04_intro_team_PLA_0")
					* ARRAY - [<actorID>(,<sentenceID>)] (example: ["PLA",0] or just ["PLA_0"])
					* BOOL - true to play random sentence, false to play first sentence
					* default - first sentence
				endingSentence can be in format:
					* STRING - full sentence name (example: 04_intro_team_PLA_0")
					* ARRAY - [<actorID>(,<sentenceID>)] (example: ["PLA",0] or just ["PLA_0"])
					* BOOL - true to play only one sentence, false if continue to last sentence
					* default - last sentence
		* (default: play everything)
	_this select 3 (Optional): BOOL or STRING or OBJECT or CODE - true to force radio, name of custom radio channel, listener's channel, returned value of code
	_this select 4 (Optional): CODE - code executed at the start of every sentence (arguments are same as in kbAddTopic event handler) (default: {})
				   ARRAY - code with arguments in format [code,arguments]
	_this select 5 (Optional):
		ARRAY - replacement units for those defined in .bikb file (in chronological order)
		BOOL - when true, dummy logics will be created for all actor units which doesn't exist (default: false or value of 'bis_fnc_kbTell_createDummy' variable)
	_this select 6 (Optional): NUMBER - music and sound volumes will be multiplied by this value when conversation starts (default: 0.1)
	_this select 7 (Optional): BOOL - true to disable radio protocol message while the conversation is playing (default: true)

	Returns:
	NOTHING
*/
//Todo: priority kbTell stppoing current conversation, split into several functions (config loading)

(Placeholder description extracted from the function header by BIS_fnc_exportFunctionsToWiki)

Execution:

call

Groups:

Uncategorised

Syntax

Syntax:

Syntax needed

Return Value:

Return value needed

Examples

Example 1:

Additional Information

See also:

See also needed

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