| Environment:
|
Mission Scripting
|
|
|
| Function:
|
PlayerWelcomeMessage
|
| Function Description:
|
Produces a greeting message to a player joining a server. Custom messages can be set to the CMM.SERVER.WELCOME string variable
|
|
|
| File Location:
|
cmm.DCSFunctions.lua
|
|
|
| Syntax:
|
CMM.PlayerWelcomeMessage( string PlayerName , number or nil DisplayTime , boolean or nil ClearView )
|
|
|
| Return Value:
|
nil
|
|
|
| Parameters:
|
Name
|
Description
|
| PlayerName | String of the players name you want to send the welcome message to (this is also used to find the unitID to send the message to) |
|---|
| DisplayTime | Length of time in seconds to show the welcome message [DEFAULT: CMM.SERVER.WELCOMETIMER or 30] |
|---|
| ClearView | If true will clear all text on screen before showing the welcome message [DEFAULT: CMM.SERVER.WELCOMECLEAR or true] |
|---|
|
|
| Example:
|
CMM.PlayerWelcomeMessage('OzDeaDMeaT')
|
| Example Description:
|
Outputs the CMM.SERVER.WELCOME message to a user named 'OzDeaDMeaT'
|
|
|
| Related Functions:
|
|
| Notes:
|
Template:PLAYERNAME will replace with the players name, Template:TIMEREMAINING will show the time remaining, cmm.ozdeadmeat.com will be replaced with the server name.
|
