cutRsc: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(separated syntax variations)
m (upd. links)
Line 14: Line 14:
| '''cutRsc''' [name, type, speed] |= Syntax
| '''cutRsc''' [name, type, speed] |= Syntax
|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 [[GUI Interaction]] 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: [[Number]] - Time in seconds to fade in resource (optional, default: 1). |= Parameter 3
| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
Line 21: Line 21:
|p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the back most. (Negative values allow placement of resources ''behind'' the current UI.)|= Parameter 1
|p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the back most. (Negative values allow placement of resources ''behind'' the current UI.)|= Parameter 1
|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 [[GUI Interaction]] 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: [[Number]] - Time in seconds to fade in resource (optional, default: 1). |= Parameter 5
|r2= [[Nothing]] |= Return value
|r2= [[Nothing]] |= Return value

Revision as of 00:53, 25 November 2009

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]
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).
Return Value:
Nothing

Alternative Syntax

Syntax:
layer cutRsc [name, type, speed] (Only available in Arma 2 or VBS2 (1.30+).)
Parameters:
layer: Number - Defines the layer in which the effect is shown, where 0 is the back most. (Negative values allow placement of resources behind the current UI.)
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).
Return Value:
Nothing

Examples

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

Additional Information

See also:
titleRsccutTextcutObj

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.

Bottom Section