cutObj: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )T([a-z])" to "$1t$3")
 
(102 intermediate revisions by 17 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97]]
[[Category:Scripting Commands OFP 1.46]]
[[Category:Scripting Commands ArmA]]


back to [[Scripting_Reference#C|COMREF]]
|game1= ofp
|version1= 1.00


<h2 style="color:#000066"> '''cutObj ''effect'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''effect:''' [[Array]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Description:'''
|gr1= GUI Control


Object background - arguments in format '''''["name", "type", speed]''''' or '''''["name", "type"]'''''.<br>
|eff= local
If speed is not given, 1 is assumed.<br>
Object can be defined in [[description.ext]].


|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}}.}}


'''Example:'''
|s1= [[cutObj]] [class, type, speed, showInMap, drawOverHUD]


'''cutObj''' ["TVSet", "plain"]<br>
|p1= class: [[String]] - the className of the object defined in {{hl|[[configFile]] >> "CfgTitles" >> class}}
'''cutObj''' ["TVSet", "plain", 10]
 
|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
 
|p3= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource
 
|p4= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
 
|p5= drawOverHUD: [[Boolean]] - (Optional, default [[true]]) [[false]] to show the object under in-game HUD
|p5since= arma3 2.16
 
|r1= [[Nothing]]
 
|s2= layer [[cutObj]] [class, type, speed, showInMap, drawOverHUD]
 
|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: [[String]] - the className of the object defined in {{hl|[[configFile]] >> "CfgTitles" >> class}}
 
|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.
 
|p24= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource
 
|p25= showInMap: [[Boolean]] - (Optional, default [[true]]) [[false]] to hide the text when the map is opened
 
|p26= drawOverHUD: [[Boolean]] - (Optional, default [[true]]) [[false]] to show the object under in-game HUD
|p26since= arma3 2.16
 
|r2= [[Nothing]]
 
|s3= layerName [[cutObj]] [class, type, speed, showInMap, drawOverHUD]
 
|s3since= arma3 1.58
 
|p41= layerName: [[String]] - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE
 
|p42= class: [[String]] - the className of the object defined in {{hl|[[configFile]] >> "CfgTitles" >> class}}
 
|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
 
|p44= speed: [[Number]] - (Optional, default -1) time in seconds to fade in resource
 
|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
 
|x1= <sqf>
cutObj ["TVSet", "PLAIN"];
cutObj ["TVSet", "PLAIN", 2];
</sqf>
 
|x2= <sqf>2 cutObj ["Sphere", "PLAIN"];</sqf>
 
|x3= <sqf>private _layer = "layer1" cutObj ["BISLogo", "PLAIN"];</sqf>
 
|seealso= [[allCutLayers]] [[titleObj]] [[cutText]] [[cutRsc]] [[cutFadeOut]] [[allActiveTitleEffects]] [[activeTitleEffectParams]]
}}

Latest revision as of 12: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"