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




Introduced in

Version:3.6

Description

Description:IMPORTANT: This function only works when VBS is started with the -gateway switch.

Sends strings through the active adaptors to connected clients. Other Gateway clients will log the message.

Note: Results may vary on other clients.

Syntax

Syntax:[message] call Gateway_SendString
Parameters:
  • message: String - The message to send.
Return Value:Nothing

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:
// Displays 'Mission Success' in the connected client's log
[ "Mission Success" ] call Gateway_SendString;

Additional Information

See also: 
Multiplayer:The function returns nil, if not used in multiplayer or when Gateway is not active (the -gateway start-up parameter is not used).
Problems: 

Notes






Known issue:
Gateway 1.2 only supports sending the first message. MAK RTI using RPR1 only supports sending the first message.