cutObj
Jump to navigation
Jump to search
Description
- Description:
- Description needed
- Groups:
- GUI Control
Syntax 1
- Syntax:
- Syntax needed
- Parameters:
- [class, type, speed, showInMap]: Array
- class: String - the className of the object defined in configFile >> "CfgTitles" >> class
- 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
- showInMap (Optional): Boolean - false to hide the text when the map is opened. Default: true
- Return Value:
- Return value needed
Syntax 2
- Syntax:
- layer cutObj [class, type, speed, showInMap]
- 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, showInMap]: Array
- class: String - the className of the object defined in configFile >> "CfgTitles" >> class
- 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 - (Optional, default -1) Time in seconds to fade in resource.
- showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened.
- Return Value:
- Nothing
Syntax 3
- Syntax:
- layerName cutObj [class, type, speed, showInMap] Template:Since
- Parameters:
- layerName: String - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE
- [class, type, speed, showInMap]: Array
- class: String - the className of the object defined in configFile >> "CfgTitles" >> class
- 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
- showInMap (Optional): Boolean - false to hide the text when the map is opened. Default: true
- Return Value:
- Number - number of the allocated layer
Examples
- Example 1:
cutObj ["TVSet", "PLAIN"]; cutObj ["TVSet", "PLAIN", 2]
- Example 2:
2 cutObj ["Sphere", "PLAIN"];
- Example 3:
private _layer = "layer1" cutObj ["BISLogo", "PLAIN"];
Additional Information
- See also:
- See also needed
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