titleRsc: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| ofp |Game name=
| ofp |Game name=
Line 7: Line 6:


|gr1= GUI Control |GROUP1=
|gr1= GUI Control |GROUP1=
____________________________________________________________________________________________


| Display a resource defined in RscTitles. 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=
Line 25: Line 22:


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


| [[titleText]], [[titleObj]], [[cutRsc]], [[allActiveTitleEffects]] |SEEALSO=
| [[titleText]], [[titleObj]], [[cutRsc]], [[allActiveTitleEffects]] |SEEALSO=

Revision as of 04:59, 17 January 2021

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:
GUI Control

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: 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:
titleTexttitleObjcutRscallActiveTitleEffects

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

Bottom Section