cutObj: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "{{Command " to "{{RV|type=command ") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *PARAMETER[0-9]{1,3} *= * " to " ") |
||
Line 28: | Line 28: | ||
|s2= layer [[cutObj]] [class, type, speed, showInMap] | |s2= layer [[cutObj]] [class, type, speed, showInMap] | ||
|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. | |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. | ||
|p22= [class, type, speed, showInMap]: [[Array]] | |p22= [class, type, speed, showInMap]: [[Array]] | ||
|p23= class: [[String]] - the className of the object defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt> | |p23= class: [[String]] - the className of the object defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt> | ||
|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. | |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. | ||
|p25= speed: [[Number]] - (Optional, default -1) Time in seconds to fade in resource. | |p25= speed: [[Number]] - (Optional, default -1) Time in seconds to fade in resource. | ||
|p26= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. | |p26= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. | ||
|r2= [[Nothing]] | |r2= [[Nothing]] | ||
Line 44: | Line 44: | ||
|s3= layerName [[cutObj]] [class, type, speed, showInMap] {{Since|arma3|1.57.134673|y}} | |s3= layerName [[cutObj]] [class, type, speed, showInMap] {{Since|arma3|1.57.134673|y}} | ||
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE | |p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE | ||
|p42= [class, type, speed, showInMap]: [[Array]] | |p42= [class, type, speed, showInMap]: [[Array]] | ||
|p43= class: [[String]] - the className of the object defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt> | |p43= class: [[String]] - the className of the object defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt> | ||
|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. | |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. | ||
|p45= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 | |p45= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 | ||
|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]] | |p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]] | ||
|r3= [[Number]] - number of the allocated layer | |r3= [[Number]] - number of the allocated layer |
Revision as of 18:10, 29 January 2021
Description
- Description:
- Description needed
- Groups:
- GUI Control
Syntax 1
- Syntax:
- Syntax needed
- Parameters:
- [class, type, speed, showInMap]: Array
- class: String - the className of the object defined in configFile >> "CfgTitles" >> class
- 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:
- Return value needed
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 defined in configFile >> "CfgTitles" >> class
- 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: Number - (Optional, default -1) Time in seconds to fade in resource.
- showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened.
- Return Value:
- Nothing
Syntax 3
- Syntax:
- layerName cutObj [class, type, speed, showInMap] Template:Since
- 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 defined in configFile >> "CfgTitles" >> class
- 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:
private _layer = "layer1" cutObj ["BISLogo", "PLAIN"];
Additional Information
- See also:
- See also needed
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