titleRsc: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(62 intermediate revisions by 14 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 - argument in format ["name", "type", speed] or ["name", "type"] If speed is not given, it is assumed 1. 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


| '''titleRsc''' effect |= Syntax
|game4= arma2
|version4= 1.00


|p1= effect: [[Array]] |= Parameter 1
|game5= arma2oa
|version5= 1.50


| [[Nothing]] |= Return value
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00
 
|x1= <pre>titleRsc ["BIS", "PLAIN"]</pre> |= Example 1
____________________________________________________________________________________________


| |= See also
|game7= arma3
|version7= 0.50


|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|{{GVI|arma3|1.58}} Multiple layers and map overlays are possible with [[cutRsc]] which provides more options and handles layers better.}}
|s1= [[titleRsc]] [text, type, speed, showInMap]
|p1= text: [[String]] - the class name of the resource. ("Default" will remove the current resource)
|p2= type: [[String]] - can be 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= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
|r1= [[Nothing]]
|x1= <sqf>titleRsc ["BIS", "PLAIN"];</sqf>
|seealso= [[titleText]] [[titleObj]] [[cutRsc]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Dr_Eyeball
<!-- Note Section BEGIN -->
|timestamp= 20080630084400
|text= 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'.
}}


<!-- Note Section END -->
{{Note
</dl>
|user= Kenoxite
|timestamp= 20140925100400
|text= In OFP/CWA any ''<x>''Rsc will hide all the elements of the HUD, including the map.
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|TITLERSC]]
|user= Honger
[[Category:Scripting Commands OFP 1.96|TITLERSC]]
|timestamp= 20230828163424
[[Category:Scripting Commands OFP 1.46|TITLERSC]]
|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.
[[Category:Scripting Commands ArmA|TITLERSC]]
}}

Latest revision as of 11:24, 8 November 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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
Arma 3 logo black.png1.58 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 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:
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
Dr_Eyeball - c
Posted on Jun 30, 2008 - 08:44 (UTC)
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'.
Kenoxite - c
Posted on Sep 25, 2014 - 10:04 (UTC)
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=348002"