titleRsc: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
(One intermediate revision by one other user not shown)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Resource title - Resource can be defined in [[Description.ext]] Also see [[cutRsc]], with these two commands you can show two different resources at once. |= Description
| Display a resource defined in RscTitles. Also see [[cutRsc]], with these two commands you can show two different resources at once. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________




| '''titleRsc''' [text, type, speed, showInMap] |= Syntax
| '''titleRsc''' [text, type, speed, showInMap] |SYNTAX=


|p1= [text, type, speed]: [[Array]] |= Parameter 1
|p1= [text, type, speed]: [[Array]] |PARAMETER1=
|p2= text: [[String]] - the class name of the resource. ("Default" will remove the current resource.)|= Parameter 2
|p2= text: [[String]] - the class name of the resource. ("Default" will remove the current resource.)|PARAMETER2=
|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
|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.|PARAMETER2=
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER3=
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER3=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[titleRsc]] ["BIS", "PLAIN"]</code> |= Example 1
|x1= <code>[[titleRsc]] ["BIS", "PLAIN"]</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[cutRsc]] |= See also
| [[cutRsc]] |SEEALSO=


}}
}}

Revision as of 15:50, 7 April 2019

Logo A0.png1.00
Hover & click on the images for description

Description

Description:
Display a resource defined in RscTitles. Also see cutRsc, with these two commands you can show two different resources at once.
Groups:
Uncategorised

Syntax

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

Examples

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

Additional Information

See also:
cutRsc

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

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'.

Bottom Section

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.
Retrieved from "https://community.bistudio.com/wiki?title=titleRsc&oldid=122899"