cutRsc: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
Line 10: Line 10:


| Display a resource defined in RscTitles of the mission's [[Description.ext]], the campaign's description.ext or the global config.<br><br>
| Display a resource defined in RscTitles of the mission's [[Description.ext]], the campaign's description.ext or the global config.<br><br>
{{Feature arma3|For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673}}|= Description
{{Feature arma3|For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673}}|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''cutRsc''' [class, type, speed, showInMap] |= Syntax
| '''cutRsc''' [class, type, speed, showInMap] |SYNTAX=
|p1= [class, type, speed, showInMap]: [[Array]]|=
|p1= [class, type, speed, showInMap]: [[Array]]|=
|p2= class: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |= Parameter 1
|p2= class: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |PARAMETER1=
|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
|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.|PARAMETER2=
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER3=
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER3=
| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=


|s2= layer '''cutRsc''' [class, type, speed, showInMap]|= Syntax
|s2= layer '''cutRsc''' [class, type, speed, showInMap]|SYNTAX=
|p21= layer: [[Number]] - layer number on which the effect is shown, where 0 is the back most. Layer number is rounded to the nearest integer and also cannot be negative. Layer 99.5 will be treated as layer 100. |= Parameter 1
|p21= layer: [[Number]] - layer number on which the effect is shown, where 0 is the back most. Layer number is rounded to the nearest integer and also cannot be negative. Layer 99.5 will be treated as layer 100. |PARAMETER1=
|p22 = [class, type, speed, showInMap]: [[Array]]|=
|p22 = [class, type, speed, showInMap]: [[Array]]|=
|p23= class: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |= Parameter 3
|p23= class: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |PARAMETER3=
|p24= 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
|p24= 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.|PARAMETER2=
|p25= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
|p25= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER3=
|p26= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3
|p26= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER3=
|r2= [[Nothing]] |= Return value
|r2= [[Nothing]] |RETURNVALUE=


|s3= layerName '''cutRsc''' [class, type, speed, showInMap] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.57.134673'') |= Syntax
|s3= layerName '''cutRsc''' [class, type, speed, showInMap] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.57.134673'') |SYNTAX=
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE |= Parameter 1
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE |PARAMETER1=
|p42= [class, type, speed, showInMap]: [[Array]] |=
|p42= [class, type, speed, showInMap]: [[Array]] |=
|p43= class: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |= Parameter 3
|p43= class: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |PARAMETER3=
|p44= 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
|p44= 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.|PARAMETER2=
|p45= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
|p45= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER3=
|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3
|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER3=
|r3= [[Number]] - number of the allocated layer |= Return value
|r3= [[Number]] - number of the allocated layer |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[cutRsc]] ["binocular", "PLAIN"];
|x1= <code>[[cutRsc]] ["binocular", "PLAIN"];
[[cutRsc]] ["binocular", "PLAIN", 2];
[[cutRsc]] ["binocular", "PLAIN", 2];
[[cutRsc]] ["binocular", "PLAIN", 2, [[false]]];</code> |= Example 1
[[cutRsc]] ["binocular", "PLAIN", 2, [[false]]];</code> |EXAMPLE1=


|x2= <code>2 [[cutRsc]] ["binocular", "PLAIN", 2];</code> |= Example 2
|x2= <code>2 [[cutRsc]] ["binocular", "PLAIN", 2];</code> |EXAMPLE2=


|x3= <code>_layer = "layer1" [[cutRsc]] ["binocular", "PLAIN", 2];</code> |= Example 3
|x3= <code>_layer = "layer1" [[cutRsc]] ["binocular", "PLAIN", 2];</code> |EXAMPLE3=
|x4= Create IGUI display: <code>"someLayer" [[cutRsc]] ["RscTitleDisplayEmpty", "PLAIN"];
|x4= Create IGUI display: <code>"someLayer" [[cutRsc]] ["RscTitleDisplayEmpty", "PLAIN"];
_display <nowiki>=</nowiki> [[uiNamespace]] [[getVariable]] "RscTitleDisplayEmpty";</code> |= Example 4
_display <nowiki>=</nowiki> [[uiNamespace]] [[getVariable]] "RscTitleDisplayEmpty";</code> |EXAMPLE4=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[allCutLayers]], [[titleRsc]], [[cutText]], [[cutObj]], [[cutFadeOut]], [[setTitleEffect]] |= See also
| [[allCutLayers]], [[titleRsc]], [[cutText]], [[cutObj]], [[cutFadeOut]], [[setTitleEffect]] |SEEALSO=


}}
}}

Revision as of 15:37, 7 April 2019

Hover & click on the images for description

Description

Description:
Display a resource defined in RscTitles of the mission's Description.ext, the campaign's description.ext or the global config.

Arma 3
For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673
Groups:
Uncategorised

Syntax 1

Syntax:
cutRsc [class, type, speed, showInMap]
Parameters:
[class, type, speed, showInMap]: Array
class: 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

Syntax 2

Syntax:
layer cutRsc [class, type, speed, showInMap]
Parameters:
layer: Number - layer number on which the effect is shown, where 0 is the back most. Layer number is rounded to the nearest integer and also cannot be negative. Layer 99.5 will be treated as layer 100.
[class, type, speed, showInMap]: Array
class: 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

Syntax 3

Syntax:
layerName cutRsc [class, type, speed, showInMap]        (Since Arma 3 v1.57.134673)
Parameters:
layerName: String - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE
[class, type, speed, showInMap]: Array
class: 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:
Number - number of the allocated layer

Examples

Example 1:
cutRsc ["binocular", "PLAIN"]; cutRsc ["binocular", "PLAIN", 2]; cutRsc ["binocular", "PLAIN", 2, false];
Example 2:
2 cutRsc ["binocular", "PLAIN", 2];
Example 3:
_layer = "layer1" cutRsc ["binocular", "PLAIN", 2];
Example 4:
Create IGUI display: "someLayer" cutRsc ["RscTitleDisplayEmpty", "PLAIN"]; _display = uiNamespace getVariable "RscTitleDisplayEmpty";

Additional Information

See also:
allCutLayerstitleRsccutTextcutObjcutFadeOutsetTitleEffect

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 cutRsc (instead of titleRsc) for a HUD has the benefits of:
  • having the HUD automatically hide itself when you access the map and redisplay itself after closing the map.
  • using the 'Direct communication' chat channel messages will not interfere with the HUD by hiding it.
Posted on 17 Oct, 2013
Killzone_Kid
Regarding removing current resource with cutRsc ["Default", "PLAIN"]. If it does't work and it gives you error message that "Default" is not found, add it by yourself to RscTitles in description.ext so it looks like this:
class RscTitles
{
	class Default 
	{
		idd = -1;
		fadein = 0;
		fadeout = 0;
		duration = 0;
	};
};

Alternatively, you can use cutText, yes cutText command to cancel your resources. As Karel Moricky explains: "All 'cut' commands are in the same layer, the same as all 'title' commands are in another one." So to remove cutRsc resource execute cutText on the same layer:

cutRsc ["myRsc", "PLAIN"]; //show cutText ["", "PLAIN"]; //remove

10 cutRsc ["myRsc", "PLAIN"]; //show 10 cutText ["", "PLAIN"]; //remove

Also if you use layers would be a good idea to register them with BIS_fnc_rscLayer to avoid possible clashes with other layers: ("myLayerName" call BIS_fnc_rscLayer) cutRsc ["myRsc","PLAIN"]; //show ("myLayerName" call BIS_fnc_rscLayer) cutText ["","PLAIN"]; //remove

You can also immediately remove resource with cutFadeOut command:123 cutFadeOut 0;

Bottom Section