Page tree
Skip to end of metadata
Go to start of metadata




Introduced in

Version:2.06

Description

Description:

Displays a string, centered at the top of the screen.

If called multiple times, new lines are either inserted above the existing text (as in radio messages), or can replace existing text (for example, when using countdown timers).

Syntax

Syntax:[text,duration,index,insert] call fn_vbs_sysText
Parameters:
  • text: String - Text to display.
  • duration: Number - Number of seconds the text should be shown.
  • id: Number - Index number of existing text, which should be replaced (optional, default: if no index is given, the new line is inserted at the top).
  • insert: Boolean - Whether an updated message (using an existing index) should be inserted at the top. If true, then the new message gets added to the top, and the old one gets removed. If false, then the new message gets displayed at the position of the message it replaces (optional, default: true).
Return Value:Number - Index number of created text, which can be used in another call to replace the existing message.

Warning

When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.

Examples

Examples:
Creates two lines: "Line One", and below it, "Line Two":
["Line Two",10] call fn_vbs_sysText;
["Line One",10] call fn_vbs_sysText; // will be inserted *above* the already shown "Line Two"


Create a line, and then update it:

_id = ["Line One",10] call fn_vbs_sysText;
sleep 1;
["Line Two",10,_id] call fn_vbs_sysText;

Additional Information

See also: 
Multiplayer: 
Problems: 

Notes