{"name":"cutObj","title":"cutObj","type":"command","url":"https://community.bistudio.com/wiki/cutObj","revid":348145,"updated":"2023-11-08T11:32:40Z","groups":["GUI Control"],"status":"ok","games":{"ofp":"1.00","ofpe":"1.00","arma1":"1.00","arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"ofp 1.00","arma3_since":"0.50","locality":{"effect":"local"},"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]","params":[{"name":"class","type":"String","description":"the className of the object defined in `configFile >> \"CfgTitles\" >> class`","type_expr":"String"},{"name":"type","type":"String","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","type_expr":"String"},{"name":"speed","type":"Number","optional":true,"default":"-1","description":"time in seconds to fade in resource","type_expr":"Number","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","type_expr":"Boolean","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","type_expr":"Boolean","since":"arma3 2.16","text":"drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD"}],"returns":{"type":"Nothing","type_expr":"Nothing"},"form":"unary","right":{"text":"[class, type, speed, showInMap, drawOverHUD]"}},{"syntax":"layer cutObj [class, type, speed, showInMap, drawOverHUD]","params":[{"name":"layer","type":"Number","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","type_expr":"Number"},{"name":"class","type":"String","description":"the className of the object defined in `configFile >> \"CfgTitles\" >> class`","type_expr":"String"},{"name":"type","type":"String","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.","type_expr":"String"},{"name":"speed","type":"Number","optional":true,"default":"-1","description":"time in seconds to fade in resource","type_expr":"Number","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","type_expr":"Boolean","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","type_expr":"Boolean","since":"arma3 2.16","text":"drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD"}],"returns":{"type":"Nothing","type_expr":"Nothing"},"form":"binary","left":{"text":"layer"},"right":{"text":"[class, type, speed, showInMap, drawOverHUD]"}},{"syntax":"layerName cutObj [class, type, speed, showInMap, drawOverHUD]","since":"arma3 1.58","params":[{"name":"layerName","type":"String","description":"layer name on which the effect is shown. Layer names are CaSe SeNsItIvE","type_expr":"String"},{"name":"class","type":"String","description":"the className of the object defined in `configFile >> \"CfgTitles\" >> class`","type_expr":"String"},{"name":"type","type":"String","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","type_expr":"String"},{"name":"speed","type":"Number","optional":true,"default":"-1","description":"time in seconds to fade in resource","type_expr":"Number","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","type_expr":"Boolean","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","type_expr":"Boolean","since":"arma3 2.16","text":"drawOverHUD: Boolean - (Optional, default true) false to show the object under in-game HUD"}],"returns":{"type":"Number","type_expr":"Number","description":"number of the allocated layer"},"form":"binary","left":{"text":"layerName"},"right":{"text":"[class, type, speed, showInMap, drawOverHUD]"}}],"examples":[{"code":["cutObj [\"TVSet\", \"PLAIN\"];\ncutObj [\"TVSet\", \"PLAIN\", 2];"]},{"code":["2 cutObj [\"Sphere\", \"PLAIN\"];"]},{"code":["private _layer = \"layer1\" cutObj [\"BISLogo\", \"PLAIN\"];"]}],"see_also":["allCutLayers","titleObj","cutText","cutRsc","cutFadeOut","allActiveTitleEffects","activeTitleEffectParams"]}