cutObj

1.00

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 available with alternative syntax since Arma 3 v1.57.134673

Groups:

Uncategorised

Syntax 1

Syntax:

cutObj [class, type, speed, showInMap]

Parameters:

[class, type, speed, showInMap]: Array

class: String - the className of the object

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 is seconds, in which the object will be faded in. If no speed is given, 1 is assumed.

showInMap (Optional): Boolean - false to hide the resource when the map is opened (default: true) Introduced in Arma 3.

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, type, speed, showInMap]: Array

class: String - the className of the object

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 is seconds, in which the object will be faded in. If no speed is given, 1 is assumed.

showInMap (Optional): Boolean - false to hide the resource when the map is opened (default: true) Introduced in Arma 3.

Return Value:

Nothing

Syntax 3

Syntax:

layerName cutObj [class, type, speed, showInMap]        (Since Arma 3 v1.57.134673)

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

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 is seconds, in which the object will be faded in. If no speed is given, 1 is assumed.

showInMap (Optional): Boolean - false to hide the resource when the map is opened (default: true) Introduced in Arma 3.

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:

_layer = "layer1" cutObj ["BISLogo", "PLAIN"];

Additional Information

See also:

allCutLayerstitleObjcutTextcutRsccutFadeOut

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