{"name":"titleText","title":"titleText","type":"command","url":"https://community.bistudio.com/wiki/titleText","revid":336846,"updated":"2023-01-04T16:43:44Z","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 text across the screen. If used along with cutText two different texts (in different type styles) can be shown at once.\nThe text can be displayed on multiple lines by using \"\\n\" new line characters (see Example 3).","syntaxes":[{"syntax":"titleText [text, type, speed, showInMap, isStructuredText]","params":[{"name":"text","type":"String","description":"text to be displayed","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":"isStructuredText","type":"Boolean","optional":true,"default":"false","description":"true to switch support for Structured Text formatting - see Example 4","type_expr":"Boolean","since":"arma3 1.74","text":"isStructuredText: Boolean - (Optional, default false) true to switch support for Structured Text formatting - see Example 4"}],"returns":{"type":"Nothing","type_expr":"Nothing"},"form":"unary","right":{"text":"[text, type, speed, showInMap, isStructuredText]"}}],"examples":[{"code":["titleText [\"Show this text\", \"PLAIN\"];"]},{"code":["titleText [\"Your message\", \"BLACK\", 2];"]},{"code":["titleText [\"line1\\nline2\\nline3\", \"PLAIN\"];"]},{"code":["titleText [\"<t color='#ff0000' size='5'>RED ALERT!</t><br/>***********\", \"PLAIN\", -1, true, true];"]}],"see_also":["titleFadeOut","cutText","cutObj","allActiveTitleEffects","activeTitleEffectParams"],"notes":[{"user":"DreadedEntity","date":"2014-11-21T09:03:00Z","text":"The third parameter or 'speed', as it is called in the description, refers to the amount of time the message will be shown on-screen. Multiply each number by 10 to get the number of seconds it will be shown. You can even use floats as input, like 0.1, to show a message for only 1 second.\n\n**Note**: Calculating the time with that method does not include the time it takes to fade in/out, which is about 1 second unless you use numbers lower than 1.\n**Note**: Using anything lower than 0.001 seems to have no effect, or the effect is so little it is negligible.\n**(A3 1.34.128075)**"}]}