cutObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
Line 10: Line 10:


| Displays an object defined in the global config in CfgTitles.<br><br>
| Displays an object defined in the global config in CfgTitles.<br><br>
{{Feature arma3|For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673}}|= Description
{{Feature arma3|For greater efficiency and ease of modability it is recommended to use named layers available with alternative syntax since Arma 3 v1.57.134673}}|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''cutObj''' [class, type, speed, showInMap] |= Syntax
| '''cutObj''' [class, type, speed, showInMap] |SYNTAX=
|p1= [class, type, speed, showInMap]: [[Array]] |=
|p1= [class, type, speed, showInMap]: [[Array]] |=
|p2= class: [[String]] - the className of the object |= Parameter 3
|p2= class: [[String]] - the className of the object |PARAMETER3=
|p3= 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= 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.|PARAMETER2=
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER3=
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER3=
| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=


|s2= layer '''cutObj''' [class, type, speed, showInMap] |= Syntax
|s2= layer '''cutObj''' [class, type, speed, showInMap] |SYNTAX=
|p21= 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. |= Parameter 1
|p21= 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. |PARAMETER1=
|p22= [class, type, speed, showInMap]: [[Array]] |=
|p22= [class, type, speed, showInMap]: [[Array]] |=
|p23= class: [[String]] - the className of the object |= Parameter 3
|p23= class: [[String]] - the className of the object |PARAMETER3=
|p24= 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
|p24= 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.|PARAMETER2=
|p25= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
|p25= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER3=
|p26= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3 |=
|p26= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER3=  |=


|r2= [[Nothing]] |= Return value
|r2= [[Nothing]] |RETURNVALUE=


|s3= layerName '''cutObj''' [class, type, speed, showInMap] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.57.134673'') |= Syntax
|s3= layerName '''cutObj''' [class, type, speed, showInMap] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.57.134673'') |SYNTAX=
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE|= Parameter 1
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE|PARAMETER1=
|p42= [class, type, speed, showInMap]: [[Array]] |=
|p42= [class, type, speed, showInMap]: [[Array]] |=
|p43= class: [[String]] - the className of the object |= Parameter 3
|p43= class: [[String]] - the className of the object |PARAMETER3=
|p44= 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
|p44= 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.|PARAMETER2=
|p45= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |= Parameter 3
|p45= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER3=
|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |= Parameter 3 |=
|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER3= |=


|r3= [[Number]] - number of the allocated layer |= Return value
|r3= [[Number]] - number of the allocated layer |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[cutObj]] ["TVSet", "PLAIN"];
|x1= <code>[[cutObj]] ["TVSet", "PLAIN"];
[[cutObj]] ["TVSet", "PLAIN", 2]</code> |= Example 1
[[cutObj]] ["TVSet", "PLAIN", 2]</code> |EXAMPLE1=


|x2= <code>2 [[cutObj]] ["Sphere", "PLAIN"];</code> |= Example 2
|x2= <code>2 [[cutObj]] ["Sphere", "PLAIN"];</code> |EXAMPLE2=


|x3= <code>_layer = "layer1" [[cutObj]] ["BISLogo", "PLAIN"];</code> |= Example 3
|x3= <code>_layer = "layer1" [[cutObj]] ["BISLogo", "PLAIN"];</code> |EXAMPLE3=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[allCutLayers]], [[titleObj]], [[cutText]], [[cutRsc]], [[cutFadeOut]] |= See also
| [[allCutLayers]], [[titleObj]], [[cutText]], [[cutRsc]], [[cutFadeOut]] |SEEALSO=


}}
}}

Revision as of 14:37, 7 April 2019

Logo A0.png1.00
LELocal
Hover & click on the images for description

Description

Description:
Displays an object defined in the global config in CfgTitles.

Arma 3
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 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:
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 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:
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 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:
_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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=cutObj&oldid=121345"