Scripting/Squirrel/Functions/GetJoinMessages: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
(Created page with "This function will return the current status of the join messages. == Syntax == <pre>EnabledJoinMessages()</pre> == Arguments == '''N/A''' == Return value == * ''bool'' ...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
== Syntax ==
== Syntax ==


<pre>EnabledJoinMessages()</pre>
<pre>GetJoinMessages()</pre>


== Arguments ==
== Arguments ==
Line 14: Line 14:


== Example ==
== Example ==
 
The following example messages if join message is enabled or not when player types the command.<source lang=squirrel>
{{Scripting/Needs_Example}}
function onPlayerCommand( player, cmd, text );
{
  if ( cmd == "messages" )
  {  
    if( GetJoinMessages() ) MessagePlayer("Join messages are enabled.", player );
    else MessagePlayer("Join messages are disabled.", player );
  }
</source>


=== Notes ===
=== Notes ===
 
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.


== Related Functions ==
== Related Functions ==


{{Scripting/Squirrel/Functions/Server_Settings}}
{{Scripting/Squirrel/Functions/Server Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Latest revision as of 19:13, 30 January 2017

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

Retrieved from "http://wiki.vc-mp.org/index.php?title=Scripting/Squirrel/Functions/GetJoinMessages&oldid=19772"