GetWhiteScanLines

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function works in Vice Unleashed only.

This function will return a boolean value of either true or false depending on what is the current status of white scan lines.

Syntax

bool GetWhiteScanLines( [ Player plr ] )

Arguments

• plr - If this optional argument is used, the status of the given player is returned. Otherwise returns the global scan line status

Example

This example returns the global status of white scan lines when someone types '/whitescan'.

 
function onPlayerCommand( player, command, text )
{
     if ( command == "whitescan" ) MessagePlayer( "White scan line status is currently set to " + GetWhiteScanLines(), player );
     
     return 1;
}
 

Notes

This is useful for checking that the white scan line aren't already active before setting it to true.

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

Related Functions

• FadeCamera
• GetCinematicBorder
• GetGreenScanLines
• GetWhiteScanLines
• RestoreCamera
• ShakeCamera
• SetCameraMatrix
• SetCinematicBorder
• SetGreenScanLines
• SetWhiteScanLines