titleRsc: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.00|Game version=
|1.00


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


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


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


|p1= [text, type, speed]: [[Array]] |PARAMETER1=
|p1= [text, type, speed]: [[Array]]


|p2= text: [[String]] - the class name of the resource. ("Default" will remove the current resource.)|PARAMETER2=
|p2= text: [[String]] - the class name of the resource. ("Default" will remove the current resource.)


|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.|PARAMETER3=
|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.


|p4= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource |PARAMETER4=
|p4= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource


|p5= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. |PARAMETER5=
|p5= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened.


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


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


Revision as of 12:25, 18 January 2021

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