SetCinematicBorder

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

This function will activate/deactive the cinematic border (widescreen effect).

Syntax

SetCinematicBorder can take 2 different lists of parameters. These are:

bool SetCinematicBorder( bool enabled )

bool SetCinematicBorder( Player plr, bool enabled )

Arguments

• enabled - true/false to enable/disable the cinematic border
• plr - The player to enable/disable cinematic border for. If this argument is not used, the function will enable/disable the setting globally

Example

This will turn the cinematic view for all players on when someone types '/cinema'.

 
function onPlayerCommand( player, command, text )
{
     if ( command == "cinema" ) SetCinematicBorder( true );
     
     return 1;
}
 

Notes

The event onPlayerCommand was used in this example. More info about it in the corresponding page.

Related Functions

• FadeCamera
• GetCinematicBorder
• RestoreCamera
• ShakeCamera
• SetCameraMatrix
• SetCinematicBorder