cutObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.00|Game version=
|1.00


|gr1= GUI Control |GROUP1=
|gr1= GUI Control


|eff= local |Multiplayer Effects=
|eff= local




| Displays an object defined in the global config in CfgTitles.<br><br>
| Displays an object defined in the global config in CfgTitles.<br><br>
{{Feature|arma3|For greater efficiency and ease of modability it is recommended to use named layers with [[#Alternative_Syntax_2|Alternative Syntax 2]].}} |DESCRIPTION=
{{Feature|arma3|For greater efficiency and ease of modability it is recommended to use named layers with [[#Alternative_Syntax_2|Alternative Syntax 2]].}}


| [[cutObj]] [class, type, speed, showInMap] |SYNTAX=
| [[cutObj]] [class, type, speed, showInMap]


|p1= [class, type, speed, showInMap]: [[Array]] |Parameter1=
|p1= [class, type, speed, showInMap]: [[Array]]


|p2= class: [[String]] - the className of the object defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt>|PARAMETER2=
|p2= class: [[String]] - the className of the object defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt>


|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. |PARAMETER3=
|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.


|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER4=
|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1


|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]] |PARAMETER5=
|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


|s2= layer [[cutObj]] [class, type, speed, showInMap] |SYNTAX2=
|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. |PARAMETER21=
|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. |PARAMETER21=
Line 41: Line 41:
|p26= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. |PARAMETER26=
|p26= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. |PARAMETER26=


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]]


|s3= layerName [[cutObj]] [class, type, speed, showInMap] {{Since|arma3|1.57.134673|y}} |SYNTAX3=
|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|PARAMETER41=
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE|PARAMETER41=
Line 57: Line 57:
|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER46=
|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER46=


|r3= [[Number]] - number of the allocated layer |RETURNVALUE3=
|r3= [[Number]] - number of the allocated layer
   
   
|x1= <code>[[cutObj]] ["TVSet", "PLAIN"];
|x1= <code>[[cutObj]] ["TVSet", "PLAIN"];
[[cutObj]] ["TVSet", "PLAIN", 2]</code> |EXAMPLE1=
[[cutObj]] ["TVSet", "PLAIN", 2]</code>


|x2= <code>2 [[cutObj]] ["Sphere", "PLAIN"];</code> |EXAMPLE2=
|x2= <code>2 [[cutObj]] ["Sphere", "PLAIN"];</code>


|x3= <code>[[private]] _layer = "layer1" [[cutObj]] ["BISLogo", "PLAIN"];</code> |EXAMPLE3=
|x3= <code>[[private]] _layer = "layer1" [[cutObj]] ["BISLogo", "PLAIN"];</code>


| [[allCutLayers]], [[titleObj]], [[cutText]], [[cutRsc]], [[cutFadeOut]], [[allActiveTitleEffects]] |SEEALSO=
| [[allCutLayers]], [[titleObj]], [[cutText]], [[cutRsc]], [[cutFadeOut]], [[allActiveTitleEffects]]
}}
}}


Revision as of 00:30, 18 January 2021

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

Description

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

Arma 3
For greater efficiency and ease of modability it is recommended to use named layers with Alternative Syntax 2.
Groups:
GUI Control

Syntax 1

Syntax:
cutObj [class, type, speed, showInMap]
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:
Nothing

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:
allCutLayerstitleObjcutTextcutRsccutFadeOutallActiveTitleEffects

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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=cutObj&oldid=204596"