cutObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(wip)
(alt syntax)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Display an object defined in the mission's description.ext, the campaign's description.ext or the global resource.cpp. |= Description
| Displays an object defined in the global config in CfgTitles.<br><br>
Since Arma 3 v1.57.134673 it is possible to allocate layers by passing layer name as parameter. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 20: Line 21:


|s2= layer '''cutObj''' [class, type, speed] |= Syntax
|s2= layer '''cutObj''' [class, type, speed] |= Syntax
|p21= layer: [[Number]] - layer in which the effect is shown, where 0 is the back most. |= 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. |= Parameter 1
|p22= [class, type, speed]: [[Array]] |=
|p22= [class, type, speed]: [[Array]] |=
|p23= class: [[String]] - the className of the object |= Parameter 3
|p23= class: [[String]] - the className of the object |= Parameter 3
Line 26: Line 27:
|p25= speed: (optional): [[Number]] - time is seconds, in which the object will be faded in. If no speed is given, 1 is assumed. |= Parameter 5
|p25= speed: (optional): [[Number]] - time is seconds, in which the object will be faded in. If no speed is given, 1 is assumed. |= Parameter 5


|s2= [[Nothing]] |= Return value
|r2= [[Nothing]] |= Return value
 
|s3= layerName '''cutObj''' [class, type, speed] &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
|p42= [class, type, speed]: [[Array]] |=
|p43= class: [[String]] - the className of the object |= Parameter 3
|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 4
|p45= speed: (optional): [[Number]] - time is seconds, in which the object will be faded in. If no speed is given, 1 is assumed. |= Parameter 5
 
|r3= [[Number]] - number of the allocated layer |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[cutObj]] ["TVSet","PLAIN"];
|x1= <code>[[cutObj]] ["TVSet", "PLAIN"];
[[cutObj]] ["TVSet","PLAIN",2]</code> |= Example 1
[[cutObj]] ["TVSet", "PLAIN", 2]</code> |= Example 1
 
|x2= <code>2 [[cutObj]] ["Sphere", "PLAIN"];</code> |= Example 2


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


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


}}
}}

Revision as of 00:17, 21 February 2016

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

Description

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

Since Arma 3 v1.57.134673 it is possible to allocate layers by passing layer name as parameter.
Groups:
Uncategorised

Syntax 1

Syntax:
cutObj [class, type, speed]
Parameters:
[class, type, speed]: 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.
Return Value:
Nothing

Syntax 2

Syntax:
layer cutObj [class, type, speed]
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]: 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.
Return Value:
Nothing

Syntax 3

Syntax:
layerName cutObj [class, type, speed]        (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]: 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.
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:
titleObjcutTextcutRsccutFadeOut

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=94447"