cutObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )T([a-z])" to "$1t$3")
 
(43 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|gr1= GUI Control |GROUP1=
|game3= arma1
|version3= 1.00


|eff= local |Multiplayer Effects=
|game4= arma2
|version4= 1.00


____________________________________________________________________________________________
|game5= arma2oa
|version5= 1.50


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


| [[cutObj]] [class, type, speed, showInMap] |SYNTAX=
|game7= arma3
|version7= 0.50


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


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


|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=
|descr= Displays an object defined in the global config in {{hl|CfgTitles}}.
{{Feature|arma3|For greater efficiency and ease of modability, it is recommended to use named layers with {{Link|#Syntax 3}}.}}


|p4= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER4=
|s1= [[cutObj]] [class, type, speed, showInMap, drawOverHUD]


|p5= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]] |PARAMETER5=
|p1= class: [[String]] - the className of the object defined in {{hl|[[configFile]] >> "CfgTitles" >> class}}


| [[Nothing]] |RETURNVALUE=
|p2= 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
____________________________________________________________________________________________


|s2= layer [[cutObj]] [class, type, speed, showInMap] |SYNTAX2=
|p3= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource


|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=
|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened


|p22= [class, type, speed, showInMap]: [[Array]] |PARAMETER22=
|p5= drawOverHUD: [[Boolean]] - (Optional, default [[true]]) [[false]] to show the object under in-game HUD
|p5since= arma3 2.16


|p23= class: [[String]] - the className of the object defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt>|PARAMETER23=
|r1= [[Nothing]]


|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.|PARAMETER24=
|s2= layer [[cutObj]] [class, type, speed, showInMap, drawOverHUD]


|p25= speed: [[Number]] - (Optional, default -1) Time in seconds to fade in resource. |PARAMETER25=
|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


|p26= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened. |PARAMETER26=
|p22= class: [[String]] - the className of the object defined in {{hl|[[configFile]] >> "CfgTitles" >> class}}


|r2= [[Nothing]] |RETURNVALUE2=
|p23= 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.
____________________________________________________________________________________________


|s3= layerName [[cutObj]] [class, type, speed, showInMap] {{since|arma3|1.57.134673|y}} |SYNTAX3=
|p24= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource


|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE|PARAMETER41=
|p25= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened


|p42= [class, type, speed, showInMap]: [[Array]] |PARAMETER42=
|p26= drawOverHUD: [[Boolean]] - (Optional, default [[true]]) [[false]] to show the object under in-game HUD
|p26since= arma3 2.16


|p43= class: [[String]] - the className of the object defined in <tt>[[configFile]] >> "CfgTitles" >> class</tt>|PARAMETER43=
|r2= [[Nothing]]


|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.|PARAMETER44=
|s3= layerName [[cutObj]] [class, type, speed, showInMap, drawOverHUD]


|p45= speed (Optional): [[Number]] - Time in seconds to fade in resource. Default: -1 |PARAMETER45=
|s3since= arma3 1.58


|p46= showInMap (Optional): [[Boolean]] - [[false]] to hide the text when the map is opened. Default: [[true]]  |PARAMETER46=
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE


|r3= [[Number]] - number of the allocated layer |RETURNVALUE3=
|p42= class: [[String]] - the className of the object defined in {{hl|[[configFile]] >> "CfgTitles" >> class}}
____________________________________________________________________________________________
 
|x1= <code>[[cutObj]] ["TVSet", "PLAIN"];
[[cutObj]] ["TVSet", "PLAIN", 2]</code> |EXAMPLE1=


|x2= <code>2 [[cutObj]] ["Sphere", "PLAIN"];</code> |EXAMPLE2=
|p43= 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


|x3= <code>[[private]] _layer = "layer1" [[cutObj]] ["BISLogo", "PLAIN"];</code> |EXAMPLE3=
|p44= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource
____________________________________________________________________________________________


| [[allCutLayers]], [[titleObj]], [[cutText]], [[cutRsc]], [[cutFadeOut]], [[allActiveTitleEffects]] |SEEALSO=
|p45= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
}}
 
|p46= drawOverHUD: [[Boolean]] - (Optional, default [[true]]) [[false]] to show the object under in-game HUD
|p46since= arma3 2.16
 
|r3= [[Number]] - number of the allocated layer


<h3 style="display:none">Notes</h3>
|x1= <sqf>
<dl class="command_description">
cutObj ["TVSet", "PLAIN"];
<!-- Note Section BEGIN -->
cutObj ["TVSet", "PLAIN", 2];
</sqf>


<!-- Note Section END -->
|x2= <sqf>2 cutObj ["Sphere", "PLAIN"];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x3= <sqf>private _layer = "layer1" cutObj ["BISLogo", "PLAIN"];</sqf>


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|seealso= [[allCutLayers]] [[titleObj]] [[cutText]] [[cutRsc]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]  
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 13:32, 8 November 2023

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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 Syntax 3.
Groups:
GUI Control

Syntax 1

Syntax:
cutObj [class, type, speed, showInMap, drawOverHUD]
Parameters:
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
since Arma 3 logo black.png2.16
drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD
Return Value:
Nothing

Syntax 2

Syntax:
layer cutObj [class, type, speed, showInMap, drawOverHUD]
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: 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
since Arma 3 logo black.png2.16
drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD
Return Value:
Nothing

Syntax 3

Syntax:
layerName cutObj [class, type, speed, showInMap, drawOverHUD]
Parameters:
layerName: String - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE
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
since Arma 3 logo black.png2.16
drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD
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:
allCutLayers titleObj cutText cutRsc cutFadeOut allActiveTitleEffects activeTitleEffectParams

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
Retrieved from "https://community.bistudio.com/wiki?title=cutObj&oldid=348145"