Scripting/Squirrel/Functions/Camera/GetWhiteScanLines

From VC-MP Wiki

This function will return the state of white scan lines for the given player.

Syntax

bool GetWhiteScanLines( Player plr )

Arguments

• plr - The player of whose status should be checked

Example

This command will return the state of white scan lines for the player.

function onPlayerCommand( player, cmd, text )
{
     if ( cmd == "whitescan" )
     {
          if ( !GetWhiteScanLiness( player ) ) MessagePlayer( "White scan lines is OFF.", player );
          else if ( GetWhiteScanLines( player ) ) MessagePlayer( "White scan lines is ON.", player );
     }
}

Notes

The function MessagePlayer and call onPlayerCommand were used in in this example. More info about them in corresponding pages.

Related Functions

• GetCinematicBorder
• GetGreenScanLines
• GetWhiteScanLines
• SetCinematicBorder
• SetGreenScanLines
• SetWhiteScanLines