cutRsc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 16: | Line 16: | ||
|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: [[Number]] - Time in seconds to fade in resource (optional, default: 1). |= Parameter 3 | ||
|p4= showOnMap: [[Boolean]] - [[false]] to hide the resource when the map is opened. |= | |p4= showOnMap: [[Boolean]] - [[false]] to hide the resource when the map is opened (''Introduced in {{arma3}}''). |= | ||
| [[Nothing]] |= Return value | | [[Nothing]] |= Return value | ||
|s2= layer '''cutRsc''' [name, type, speed,showOnMap] ('' | |s2= layer '''cutRsc''' [name, type, speed,showOnMap] (''Introduced in Arma 2 / VBS2 (1.30+).'') |= Syntax | ||
|p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the back most.|= Parameter 1 | |p21= layer: [[Number]] - Defines the layer in which the effect is shown, where 0 is the back most.|= 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 [[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: [[Number]] - Time in seconds to fade in resource (optional, default: 1). |= Parameter 5 | ||
|p25= showOnMap: [[Boolean]] - [[false]] to hide the resource when the map is opened. |= | |p25= showOnMap: [[Boolean]] - [[false]] to hide the resource when the map is opened (''Introduced in {{arma3}}''). |= | ||
|r2= [[Nothing]] |= Return value | |r2= [[Nothing]] |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ |
Revision as of 07:52, 3 July 2013
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
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.
- having the HUD automatically hide itself when you access the map and redisplay itself after closing the map.
Bottom Section
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Local Effect
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- Scripting Commands ArmA
- Command Group: Interaction
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters