cutObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(syntax format)
(wip)
Line 12: Line 12:
____________________________________________________________________________________________
____________________________________________________________________________________________


| layer '''cutObj''' [name, type, speed] |= Syntax
| '''cutObj''' [class, type, speed] |= Syntax
 
|p1= [class, type, speed]: [[Array]] |=
|p1= layer: (optional): [[Number]] - This parameter is only available in Arma 2. Omit it for earlier versions. It defines the layer in which the effect is shown, where 0 is the back most. |= Parameter 1
|p2= class: [[String]] - the className of the object |= Parameter 3
 
|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 4
|p2= [name, type, speed]: [[Array]] |=
|p4= speed: (optional): [[Number]] - time is seconds, in which the object will be faded in. If no speed is given, 1 is assumed. |= Parameter 5
 
| [[Nothing]] |= Return value
|p3= name: [[String]] - the className of the object |= Parameter 3


|p4= 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
|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
|p22= [class, type, speed]: [[Array]] |=
|p23= class: [[String]] - the className of the object |= Parameter 3
|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 4
|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


|p5= 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
 
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   

Revision as of 22:53, 20 February 2016

Hover & click on the images for description

Description

Description:
Display an object defined in the mission's description.ext, the campaign's description.ext or the global resource.cpp.
Groups:
Uncategorised

Syntax

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

Alternative Syntax

Syntax:
Nothing
Parameters:
layer: Number - layer in which the effect is shown, where 0 is the back most.
[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

Examples

Example 1:
cutObj ["TVSet","PLAIN"]; cutObj ["TVSet","PLAIN",2]
Example 2:
2 cutObj ["TVSet","PLAIN",2];

Additional Information

See also:
titleObjcutTextcutRsc

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