cutObj

1.001.001.001.001.501.000.50

LELocal

Hover & click on the images for description

Description

Description:

Displays an object defined in the global config in CfgTitles.

For greater efficiency and ease of modability, it is recommended to use named layers with Syntax 3.

Groups:

GUI Control

Syntax 1

Syntax:

cutObj [class, type, speed, showInMap, drawOverHUD]

Parameters:

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

2.16 drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD.

Return Value:

Nothing

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

2.16 drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD.

Return Value:

Nothing

1.58

Syntax 3

Syntax:

layerName cutObj [class, type, speed, showInMap]

Parameters:

layerName: String - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE

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:

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:

allCutLayers titleObj cutText cutRsc cutFadeOut allActiveTitleEffects activeTitleEffectParams

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