titleRsc: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
(19 intermediate revisions by 9 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|TITLERSC]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|TITLERSC]]
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|TITLERSC]]
[[Category:Scripting Commands ArmA|TITLERSC]]


| ofp |= Game name


<h2 style="color:#000066">'''titleRsc ''effect'''''</h2>
|1.00|= Game version
____________________________________________________________________________________________


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


'''Operand types:'''


'''effect:''' [[Array]]
| '''titleRsc''' [text, type, speed, showInMap] |= Syntax


'''Type of returned value:'''
|p1= [text, type, speed]: [[Array]] |= Parameter 1
|p2= text: [[String]] - the class name of the resource. ("Default" will remove the current resource.)|= 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.|= 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]]
| [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <code>[[titleRsc]] ["BIS", "PLAIN"]</code> |= Example 1
____________________________________________________________________________________________


'''Description:'''
| [[cutRsc]] |= See also


Resource title - argument in format '''''["name", "type", speed]''''' or '''''["name", "type"]'''''
}}


If speed is not given, it is assumed 1.
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


Resource can be defined in [[Description.ext|description.ext]]
<dd class="notedate">Posted on 30 Jun, 2008
<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'.


Also see [[cutRsc]], with these two commands you can show two different resources at once.


<!-- Note Section END -->
</dl>


'''Example:'''
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|TITLERSC]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[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}}}}]]


'''titleRsc''' ["BIS", "PLAIN"]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 25, 2014 - 10:04 (UTC)</dd>
<dt class="note">[[User:Kenoxite|Kenoxite]]</dt>
<dd class="note">
In OFP/CWA any ''<x>''Rsc will hide all the elements of the HUD, including the map.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 23:47, 30 June 2017

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=103675"