cutRsc

From Bohemia Interactive Community
Revision as of 16:30, 17 October 2013 by Killzone Kid (talk | contribs) (Default workaround note)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Display a resource defined in the mission's Description.ext, the campaign's description.ext or the global resource.cpp.
Groups:
Uncategorised

Syntax

Syntax:
cutRsc [name, type, speed, showOnMap]
Parameters:
name: 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: Number - Time in seconds to fade in resource (optional, default: 1).
showOnMap: Boolean - false to hide the resource when the map is opened (Introduced in Arma 3).
Return Value:
Nothing

Alternative Syntax

Syntax:
layer cutRsc [name, type, speed,showOnMap] (Introduced in Arma 2 / VBS2 (1.30+).)
Parameters:
layer: Number - Defines the layer in which the effect is shown, where 0 is the back most.
name: 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: Number - Time in seconds to fade in resource (optional, default: 1).
showOnMap: Boolean - false to hide the resource when the map is opened (Introduced in Arma 3).
Return Value:
Nothing

Examples

Example 1:
cutRsc ["binocular","PLAIN"]; cutRsc ["binocular","PLAIN",2];
Example 2:
2 cutRsc ["binocular","PLAIN",2];

Additional Information

See also:
titleRsccutTextcutObjsetTitleEffect

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


Bottom Section