Scripting/Squirrel/Functions/GetJoinMessages

From Vice City Multiplayer
Revision as of 19:13, 30 January 2017 by Thijn (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing

This function will return the current status of the join messages.

Syntax

GetJoinMessages()

Arguments

N/A

Return value

  • bool toggled - true or false

Example

The following example messages if join message is enabled or not when player types the command.

function onPlayerCommand( player, cmd, text );
{
  if ( cmd == "messages" ) 
  { 
    if( GetJoinMessages() ) MessagePlayer("Join messages are enabled.", player );
    else MessagePlayer("Join messages are disabled.", player );
  }

Notes

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Functions