Scripting/Squirrel/Functions/Camera/SetWhiteScanLines

From VC-MP Wiki

This function will enable or disable white scan lines for the given player.

Syntax

bool SetWhiteScanLines( Player plr, bool bEnable )

Arguments

• plr - The player of whose camera status should be set
• bEnabled - Whether to enable or disable the scan lines

Example

This command enables the white scan lines when a player types '/c whiteon'.

function onPlayerCommand( player, cmd, text )
{
	if ( cmd == "whiteon" )
	{
		SetWhiteScanLines( player, true );
        }
}

Example 2

This command disables the white scan lines when a player types '/c whiteoff'.

function onPlayerCommand( player, cmd, text )
{
	if ( cmd == "whiteoff" )
	{
		SetWhiteScanLines( player, false );
        }
}

Example 3

The white scan lines will be turned ON when the player joins...

function onPlayerJoin( player )
{
	SetWhiteScanLines( player, true );
}

Notes

The calls onPlayerJoin and onPlayerCommand were used in these examples. More info about them in corresponding pages.

Related Functions

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