cutObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (restored sytle of optional parameter)
Line 12: Line 12:
____________________________________________________________________________________________
____________________________________________________________________________________________


| (layer) '''cutObj''' [name, type, (speed)] |= Syntax
| layer '''cutObj''' [name, type, speed] |= Syntax


|p1= layer: [[Number]] - This parameter is optional and 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
|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= [name, type, speed]: [[Array]] |= Parameter 2
|p2= [name, type, speed]: [[Array]] |= Parameter 2
Line 22: Line 22:
|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
|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


|p5= speed: [[Number]] - This value is optional, 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


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value

Revision as of 17:21, 23 April 2015

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:
layer cutObj [name, type, speed]
Parameters:
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.
[name, type, speed]: Array
name: 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