titleRsc: Difference between revisions

Revision as of 09:49, 6 April 2021

1.00

Hover & click on the images for description

Description

Description:: Displays a resource defined in RscTitles. Also see cutRsc, with these two commands you can show two different resources at once.
Multiple layers and map overlays are possible with cutRsc which provides more options and handles layers better.
Groups:: GUI Control

Syntax

Syntax:: titleRsc [text, type, speed, showInMap]
Parameters:: text: String - The class name of the resource. ("Default" will remove the current resource.)
: type: String - Can be: "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: Number - (Optional, default -1) Time in seconds to fade in resource
: showInMap: Boolean - (Optional, default true) |False to hide the text when the map is opened.
Return Value:: Nothing

Examples

Example 1:: titleRsc ["BIS", "PLAIN"]

Additional Information

See also:: titleText titleObj cutRsc allActiveTitleEffects

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

Posted on 30 Jun, 2008

Dr_Eyeball

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 1: / Line 1: @@
 {{RV|type=command
-| ofp
+|game1= ofp
-|1.00
+|version1= 1.00
+|game2= ofpe
+|version2= 1.00
+|game3= arma1
+|version3= 1.00
+|game4= arma2
+|version4= 1.00
+|game5= arma2oa
+|version5= 1.51
+|game6= tkoh
+|version6= 1.00
+|game7= arma3
+|version7= 0.50
 |gr1= GUI Control
-| {{Feature|obsolete|Multiple layers and map overlays are possible with [[cutRsc]] which provides more options and handles layers better.|arma3|1.57}}
+|eff= local
-Display a resource defined in RscTitles. Also see [[cutRsc]], with these two commands you can show two different resources at once.
+|descr= Displays a resource defined in RscTitles. Also see [[cutRsc]], with these two commands you can show two different resources at once.
+{{Feature|arma3|Multiple layers and map overlays are possible with [[cutRsc]] which provides more options and handles layers better.|arma3|1.58}}
-| [[titleRsc]] [text, type, speed, showInMap]
+|s1= [[titleRsc]] [text, type, speed, showInMap]
-|p1= [text, type, speed]: [[Array]]
+|p1= text: [[String]] - The class name of the resource. ("Default" will remove the current resource.)
-|p2= text: [[String]] - the class name of the resource. ("Default" will remove the current resource.)
+|p2= type: [[String]] - Can be: "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.
-|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.
+|p3= speed: [[Number]] - (Optional, default -1) Time in seconds to fade in resource
-|p4= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource
+|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false||False]] to hide the text when the map is opened.
-|p5= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened.
+|r1= [[Nothing]]
-| [[Nothing]]
 |x1= <code>[[titleRsc]] ["BIS", "PLAIN"]</code>
@@ Line 46: / Line 69: @@
 </dl>
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}