titleRsc: Difference between revisions

Revision as of 22:40, 30 June 2017

Hover & click on the images for description

Description:: Resource title - Resource can be defined in Description.ext Also see cutRsc, with these two commands you can show two different resources at once.
Groups:: Uncategorised

Syntax:: titleRsc [text, type, speed, showInMap]
Parameters:: [text, type, speed]: Array
: text: String - the class name of the resource. ("Default" will remove the current resource.)
: type: String one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See Title Effect Types for more information about these values.
: speed (Optional): Number - Time in seconds to fade in resource. Default: -1
: showInMap (Optional): Boolean - false to hide the text when the map is opened. Default: true
Return Value:: Nothing

: 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

Posted on 30 Jun, 2008

Using titleRsc (unlike cutRsc) for a HUD will mean:

the HUD will remain visible when you access the map and overlay it.
using the 'Direct communication' chat channel messages will interfere with the HUD by hiding it, since it appears to use the same 'resource layer'.

Posted on September 25, 2014 - 10:04 (UTC)
Kenoxite: In OFP/CWA any <x>Rsc will hide all the elements of the HUD, including the map.

@@ Line 11: / Line 11: @@
-| '''titleRsc''' [text, type, speed] |= Syntax
+| '''titleRsc''' [text, type, speed, showInMap] |= Syntax
 |p1= [text, type, speed]: [[Array]] |= Parameter 1
 |p2= text: [[String]] - the class name of the resource. ("Default" will remove the current resource.)|= Parameter 2
-|p3= type: [[String]] - one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]] for more information about these values. |= Parameter 3
+|p3= type: [[String]] one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[Title Effect Type]]s for more information about these values.|= Parameter 2
-|p4= speed: [[Number]] - optional, default 1 |= Parameter 4
+|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
+|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3
 | [[Nothing]] |= Return value
 ____________________________________________________________________________________________
-|x1= <pre>titleRsc ["BIS", "PLAIN"]</pre> |= Example 1
+|x1= <code>[[titleRsc]] ["BIS", "PLAIN"]</code> |= Example 1
 ____________________________________________________________________________________________