GetCinematicBorder

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

This function will return whether the cinematic border (widescreen effect) is in use. The function will return a boolean value of either true or false.

Syntax

bool GetCinematicBorder()

Example

This example returns whether the cinematic border is in use when a player types '/cinema'.

 
function onPlayerCommand( player, command, text )
{
     if ( command == "cinema" ) MessagePlayer( "Cinematic border is currently set to " + GetCinematicBorder(), player );
     
     return 1;
}
 

Notes

This is useful for checking that the cinematic border isn't already active before setting it to true.

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

Related Functions

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