cutRsc

1.00

LELocal

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

Since Arma 3 v1.57.134673 it is possible to allocate layers by passing layer name as parameter.

Groups:

Uncategorised

Syntax 1

Syntax:

cutRsc [class, type, speed, showOnMap]

Parameters:

[class, type, speed, showOnMap]: 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).

showOnMap (Optional): Boolean - false to hide the resource when the map is opened (default: true) Introduced in Arma 3.

Return Value:

Nothing

Syntax 2

Syntax:

layer cutRsc [class, type, speed, showOnMap] (Introduced in Arma 2 / VBS2 (1.30+).)

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, showOnMap]: 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).

showOnMap (Optional): Boolean - false to hide the resource when the map is opened (default: true) Introduced in Arma 3.

Return Value:

Nothing

Syntax 3

Syntax:

layerName cutRsc [class, type, speed, showOnMap]        (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, showOnMap]: 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).

showOnMap (Optional): Boolean - false to hide the resource when the map is opened (default: true) Introduced in Arma 3.

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];

Additional Information

See also:

titleRsccutTextcutObjcutFadeOutsetTitleEffect

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;