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.
- bool GetCinematicBorder( [ Player plr ] )
- plr - If this optional argument is used, the status of the given player is returned. Otherwise returns whether the cinematic border has been enabled globally
This example returns whether the cinematic border is in use globally when a player types '/cinema'.
- function onPlayerCommand( player, command, text )
- if ( command == "cinema" ) MessagePlayer( "Cinematic border is currently set to " + GetCinematicBorder(), player );
- return 1;
This is useful for checking that the cinematic border isn't already active before setting it to true.