Description
Displays an object defined in the global config in CfgTitles.
Note
Arma 3: For greater efficiency and ease of modability, it is recommended to use named layers with #Syntax 3.
Syntax
Syntax 1
cutObj [class, type, speed, showInMap, drawOverHUD]
Parameters:
class: String - the className of the object defined inconfigFile >> "CfgTitles" >> classtype: 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 valuesspeed: Number - (Optional, default -1) time in seconds to fade in resourceshowInMap: Boolean - (Optional, default true) false to hide the text when the map is openeddrawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD (since arma3 2.16)
Returns: Nothing
Syntax 2
layer cutObj [class, type, speed, showInMap, drawOverHUD]
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 100class: String - the className of the object defined inconfigFile >> "CfgTitles" >> classtype: 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 resourceshowInMap: Boolean - (Optional, default true) false to hide the text when the map is openeddrawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD (since arma3 2.16)
Returns: Nothing
Syntax 3
since arma3 1.58
layerName cutObj [class, type, speed, showInMap, drawOverHUD]
Parameters:
layerName: String - layer name on which the effect is shown. Layer names are CaSe SeNsItIvEclass: String - the className of the object defined inconfigFile >> "CfgTitles" >> classtype: 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 valuesspeed: Number - (Optional, default -1) time in seconds to fade in resourceshowInMap: Boolean - (Optional, default true) false to hide the text when the map is openeddrawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD (since arma3 2.16)
Returns: 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"];
See also
allCutLayers · titleObj · cutText · cutRsc · cutFadeOut · allActiveTitleEffects · activeTitleEffectParams