cutObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(updated)
(Arma2 layer parameter)
Line 12: Line 12:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|p1= [name, type, speed]: [[Array]] |= Parameter 1
|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


|p2= name: [[String]] - the className of the object |= Parameter 2
|p2= [name, type, speed]: [[Array]] |= Parameter 2


|p3= type: [[String]] - one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[GUI Interaction]] for more information about these values. |= Parameter 3
|p3= name: [[String]] - the className of the object |= Parameter 3


|p4= 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 4
|p4= type: [[String]] - one of "PLAIN", "PLAIN DOWN", "BLACK", "BLACK FADED", "BLACK OUT", "BLACK IN", "WHITE OUT" and "WHITE IN". See [[GUI Interaction]] 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


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
Line 27: Line 29:
|x1= <pre>cutObj ["TVSet","PLAIN"]
|x1= <pre>cutObj ["TVSet","PLAIN"]
cutObj ["TVSet","PLAIN",2]</pre> |= Example 1
cutObj ["TVSet","PLAIN",2]</pre> |= Example 1
|x2= <pre>2 cutObj ["TVSet","PLAIN",2];</pre> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________


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


}}
}}

Revision as of 07:08, 22 June 2009

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: 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.
[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 GUI Interaction for more information about these values.
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.
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