{"name":"cutObj","operator":null,"title":"cutObj","type":"command","url":"https://community.bistudio.com/wiki/cutObj","revid":348145,"updated":"2023-11-08T11:32:40Z","groups":["GUI Control"],"status":"ok","replaced_by":[],"games":[{"game":"ofp","name":"Operation Flashpoint","version":"1.00"},{"game":"ofpe","name":"Operation Flashpoint: Elite","version":"1.00"},{"game":"arma1","name":"Armed Assault","version":"1.00"},{"game":"arma2","name":"Arma 2","version":"1.00"},{"game":"arma2oa","name":"Arma 2: Operation Arrowhead","version":"1.50"},{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},{"game":"arma3","name":"Arma 3","version":"0.50"}],"since":{"game":"ofp","name":"Operation Flashpoint","version":"1.00"},"arma3_since":"0.50","branch":null,"locality":{"argument":null,"effect":"local","server_exec":false},"exec":null,"description":"Displays an object defined in the global config in `CfgTitles`.\n\n> [!NOTE]\n> **Arma 3:** For greater efficiency and ease of modability, it is recommended to use named layers with #Syntax 3.","syntaxes":[{"syntax":"cutObj [class, type, speed, showInMap, drawOverHUD]","since":null,"effect":null,"exec":null,"params":[{"name":"class","type":"String","optional":false,"default":null,"description":"the className of the object defined in `configFile >> \"CfgTitles\" >> class`","types":["String"],"since":null,"text":"class: String - the className of the object defined in `configFile >> \"CfgTitles\" >> class`"},{"name":"type","type":"String","optional":false,"default":null,"description":"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","types":["String"],"since":null,"text":"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"},{"name":"speed","type":"Number","optional":true,"default":"-1","description":"time in seconds to fade in resource","types":["Number"],"since":null,"text":"speed: Number - (Optional, default -1) time in seconds to fade in resource"},{"name":"showInMap","type":"Boolean","optional":true,"default":"true","description":"false to hide the text when the map is opened","types":["Boolean"],"since":null,"text":"showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened"},{"name":"drawOverHUD","type":"Boolean","optional":true,"default":"true","description":"false to show the object under in-game HUD","types":["Boolean"],"since":"arma3 2.16","text":"drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD"}],"returns":{"type":"Nothing","types":["Nothing"],"description":null,"text":"Nothing"},"form":"unary","operator":null,"left":null,"right":{"text":"[class, type, speed, showInMap, drawOverHUD]","types":["Array"]}},{"syntax":"layer cutObj [class, type, speed, showInMap, drawOverHUD]","since":null,"effect":null,"exec":null,"params":[{"name":"layer","type":"Number","optional":false,"default":null,"description":"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","types":["Number"],"since":null,"text":"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"},{"name":"class","type":"String","optional":false,"default":null,"description":"the className of the object defined in `configFile >> \"CfgTitles\" >> class`","types":["String"],"since":null,"text":"class: String - the className of the object defined in `configFile >> \"CfgTitles\" >> class`"},{"name":"type","type":"String","optional":false,"default":null,"description":"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.","types":["String"],"since":null,"text":"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."},{"name":"speed","type":"Number","optional":true,"default":"-1","description":"time in seconds to fade in resource","types":["Number"],"since":null,"text":"speed: Number - (Optional, default -1) time in seconds to fade in resource"},{"name":"showInMap","type":"Boolean","optional":true,"default":"true","description":"false to hide the text when the map is opened","types":["Boolean"],"since":null,"text":"showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened"},{"name":"drawOverHUD","type":"Boolean","optional":true,"default":"true","description":"false to show the object under in-game HUD","types":["Boolean"],"since":"arma3 2.16","text":"drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD"}],"returns":{"type":"Nothing","types":["Nothing"],"description":null,"text":"Nothing"},"form":"binary","operator":null,"left":{"text":"layer","types":["Number"]},"right":{"text":"[class, type, speed, showInMap, drawOverHUD]","types":["Array"]}},{"syntax":"layerName cutObj [class, type, speed, showInMap, drawOverHUD]","since":"arma3 1.58","effect":null,"exec":null,"params":[{"name":"layerName","type":"String","optional":false,"default":null,"description":"layer name on which the effect is shown. Layer names are CaSe SeNsItIvE","types":["String"],"since":null,"text":"layerName: String - layer name on which the effect is shown. Layer names are CaSe SeNsItIvE"},{"name":"class","type":"String","optional":false,"default":null,"description":"the className of the object defined in `configFile >> \"CfgTitles\" >> class`","types":["String"],"since":null,"text":"class: String - the className of the object defined in `configFile >> \"CfgTitles\" >> class`"},{"name":"type","type":"String","optional":false,"default":null,"description":"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","types":["String"],"since":null,"text":"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"},{"name":"speed","type":"Number","optional":true,"default":"-1","description":"time in seconds to fade in resource","types":["Number"],"since":null,"text":"speed: Number - (Optional, default -1) time in seconds to fade in resource"},{"name":"showInMap","type":"Boolean","optional":true,"default":"true","description":"false to hide the text when the map is opened","types":["Boolean"],"since":null,"text":"showInMap: Boolean - (Optional, default true) false to hide the text when the map is opened"},{"name":"drawOverHUD","type":"Boolean","optional":true,"default":"true","description":"false to show the object under in-game HUD","types":["Boolean"],"since":"arma3 2.16","text":"drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD"}],"returns":{"type":"Number","types":["Number"],"description":"number of the allocated layer","text":"Number - number of the allocated layer"},"form":"binary","operator":null,"left":{"text":"layerName","types":["String"]},"right":{"text":"[class, type, speed, showInMap, drawOverHUD]","types":["Array"]}}],"examples":[{"text":"```sqf\ncutObj [\"TVSet\", \"PLAIN\"];\ncutObj [\"TVSet\", \"PLAIN\", 2];\n```","code":["cutObj [\"TVSet\", \"PLAIN\"];\ncutObj [\"TVSet\", \"PLAIN\", 2];"]},{"text":"```sqf\n2 cutObj [\"Sphere\", \"PLAIN\"];\n```","code":["2 cutObj [\"Sphere\", \"PLAIN\"];"]},{"text":"```sqf\nprivate _layer = \"layer1\" cutObj [\"BISLogo\", \"PLAIN\"];\n```","code":["private _layer = \"layer1\" cutObj [\"BISLogo\", \"PLAIN\"];"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["allCutLayers","titleObj","cutText","cutRsc","cutFadeOut","allActiveTitleEffects","activeTitleEffectParams"],"notes":[],"categories":[]}