GetCinematicBorder: 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 Cinematic Border of any specified player. == Syntax == <pre>GetCinematicBorder( player )</pre> == Arguments == '''playe...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 14: Line 14:


== Example ==
== Example ==
This command will check whether the driveby is on or off
This command will check whether the Cinematic Border is on or off of the player
<source lang=squirrel>
<source lang=squirrel>
function onPlayerCommand(player,cmd,text)
function onPlayerCommand(player,cmd,text)
Line 23: Line 23:
else{
else{
local plr = GetPlayer( text );
local plr = GetPlayer( text );
if ( !plr ) MessagePlayer(RED+"** [ERROR]: >> "+WHITE+"Invalid Player.", player );
if ( !plr ) MessagePlayer("** [ERROR]: >> Invalid Player.", player );
else {
else {
MessagePlayer("Cinematic Border Status: "+GetCinematicBorder( plr.ID ),player);
MessagePlayer("Cinematic Border Status: "+GetCinematicBorder( plr ),player);
}
}
}
}
Line 37: Line 37:


By Anik
By Anik
== Related Functions ==
{{Scripting/Squirrel/Functions/Server_Settings}}

Latest revision as of 09:01, 14 March 2016

This function will return the current status of the Cinematic Border of any specified player.

Syntax

GetCinematicBorder( player )

Arguments

player = Instance of the player.

Return value

  • bool toggled - true or false

Example

This command will check whether the Cinematic Border is on or off of the player

function onPlayerCommand(player,cmd,text)
{
if(cmd=="cinematic")
{
if ( !text ) MessagePlayer("Usage: /" + cmd + " [Player/ID]", player );
else{
local plr = GetPlayer( text );
if ( !plr ) MessagePlayer("** [ERROR]: >> Invalid Player.", player );
else {
MessagePlayer("Cinematic Border Status: "+GetCinematicBorder( plr ),player);
}
}
}
}

Notes

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

By Anik