titleRsc: Difference between revisions

From Bohemia Interactive Community
mNo edit summary
No edit summary
(42 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.00


|1.00|= Game version
|game2= ofpe
____________________________________________________________________________________________
|version2= 1.00


| 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
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


|game4= arma2
|version4= 1.00


| '''titleRsc''' [text, type, speed, showInMap] |= Syntax
|game5= arma2oa
|version5= 1.50


|p1= [text, type, speed]: [[Array]] |= Parameter 1
|game6= tkoh
|p2= text: [[String]] - the class name of the resource. ("Default" will remove the current resource.)|= Parameter 2
|version6= 1.00
|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 (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
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50
 
|x1= <code>[[titleRsc]] ["BIS", "PLAIN"]</code> |= Example 1
____________________________________________________________________________________________


| [[cutRsc]] |= See also
|gr1= GUI Control


}}
|eff= local
 
|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}}
 
|s1= [[titleRsc]] [text, type, speed, showInMap]
 
|p1= text: [[String]] - The class name of the resource. ("Default" will remove the current resource.)


<h3 style="display:none">Notes</h3>
|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.
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on 30 Jun, 2008
|p3= speed: [[Number]] - (Optional, default -1) Time in seconds to fade in resource
<dt class="note">'''[[User:Dr_Eyeball|Dr_Eyeball]]'''<dd class="note">
Using [[titleRsc]] (unlike [[cutRsc]]) for a HUD will mean:
* the HUD will remain visible when you access the map and overlay it.<BR>
* using the 'Direct communication' chat channel messages will interfere with the HUD by hiding it, since it appears to use the same 'resource layer'.


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


<!-- Note Section END -->
|r1= [[Nothing]]
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>titleRsc ["BIS", "PLAIN"];</sqf>
[[Category:Scripting Commands|TITLERSC]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
|seealso= [[titleText]] [[titleObj]] [[cutRsc]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]  
[[Category:Scripting Commands OFP 1.96|TITLERSC]]
}}
[[Category:Scripting Commands OFP 1.46|TITLERSC]]
[[Category:Scripting Commands ArmA|TITLERSC]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<dl class="command_description">
<dl class="command_description">
<dd class="notedate">Posted on September 25, 2014 - 10:04 (UTC)</dd>
 
<dt><dt>
<dd class="notedate">Posted on 30 Jun, 2008</dd>
<dt class="note">[[User:Dr_Eyeball|Dr_Eyeball]]</dt>
<dd class="note">
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'.
<dt><dt>
<dd class="notedate">Posted on 2014-09-25 - 10:04 (UTC)</dd>
<dt class="note">[[User:Kenoxite|Kenoxite]]</dt>
<dt class="note">[[User:Kenoxite|Kenoxite]]</dt>
<dd class="note">
<dd class="note">
In OFP/CWA any ''<x>''Rsc will hide all the elements of the HUD, including the map.
In OFP/CWA any ''<x>''Rsc will hide all the elements of the HUD, including the map.
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
 
{{Note
|user= Honger
|timestamp= 20230828163424
|text= The "Default" resource class does not exist in Arma 3 as of 2.12 version. Use a different class to remove resources that are not finite.
}}

Revision as of 18:34, 28 August 2023

Logo A0.png 1.00ofpe logo.png 1.00Logo A1 black.png 1.00Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
LELocal
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.
Arma 3
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 activeTitleEffectParams

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 2014-09-25 - 10:04 (UTC)
Kenoxite
In OFP/CWA any <x>Rsc will hide all the elements of the HUD, including the map.
Honger - c
Posted on Aug 28, 2023 - 16:34 (UTC)
The "Default" resource class does not exist in Arma 3 as of 2.12 version. Use a different class to remove resources that are not finite.
Retrieved from "https://community.bistudio.com/wiki?title=titleRsc&oldid=347044"