cutRsc: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(edited my note)
(sintax opt params, example)
Line 15: Line 15:
|p1= name: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |= Parameter 1
|p1= name: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |= Parameter 1
|p2= 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
|p2= 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= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1). |= Parameter 3
|p3= speed (Optional): [[Number]] - Time in seconds to fade in resource (default: 1). |= Parameter 3
|p4= showOnMap: [[Boolean]] - [[false]] to hide the resource when the map is opened (''Introduced in {{arma3}}''). |=
|p4= showOnMap (Optional): [[Boolean]] - [[false]] to hide the resource when the map is opened (default: [[true]]) ''Introduced in {{arma3}}''. |=
| [[Nothing]] |= Return value
| [[Nothing]] |= Return value


Line 23: Line 23:
|p22= name: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |= Parameter 3
|p22= name: [[String]] - the class name of the resource. ("Default" will remove the current resource.) |= Parameter 3
|p23= 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 4
|p23= 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 4
|p24= speed: [[Number]] - Time in seconds to fade in resource (optional, default: 1). |= Parameter 5
|p24= speed (Optional): [[Number]] - Time in seconds to fade in resource (default: 1). |= Parameter 5
|p25= showOnMap: [[Boolean]] - [[false]] to hide the resource when the map is opened (''Introduced in {{arma3}}''). |=
|p25= showOnMap (Optional): [[Boolean]] - [[false]] to hide the resource when the map is opened (default: [[true]]) ''Introduced in {{arma3}}''. |=
|r2= [[Nothing]] |= Return value
|r2= [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[cutRsc]] ["binocular","PLAIN"];
|x1= <code>[[cutRsc]] ["binocular", "PLAIN"];
[[cutRsc]] ["binocular","PLAIN",2];</code> |= Example 1
[[cutRsc]] ["binocular", "PLAIN", 2];
[[cutRsc]] ["binocular", "PLAIN", 2, [[false]]];</code> |= Example 1


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

Revision as of 14:29, 6 May 2015

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 (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

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. Layer number is rounded to the nearest integer and also cannot be negative. Layer 99.5 will be treated as layer 100.
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 (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

Examples

Example 1:
cutRsc ["binocular", "PLAIN"]; cutRsc ["binocular", "PLAIN", 2]; cutRsc ["binocular", "PLAIN", 2, false];
Example 2:
2 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;

Bottom Section