Squirrel/Server/Functions/Camera/SetCinematicBorder

Latest revision as of 02:45, 25 September 2010

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

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

bool SetCinematicBorder( bool enabled )

bool SetCinematicBorder( Player plr, bool enabled )

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

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;
}

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

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{Squirrel/Title|SetCinematicBorder}}
-This function will activate/deactive the cinematic border.
+This function will activate/deactive the cinematic border (widescreen effect).
 == Syntax ==
-''SetCinematicBorder'' can take one parameter, this is:
+''SetCinematicBorder'' can take 2 different lists of parameters. These are:
+<code>bool SetCinematicBorder( bool enabled )</code>
+<code>bool SetCinematicBorder( Player plr, bool enabled )</code>
-<code>bool SetCinematicBorder( bool true/false )</code>
+== 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'.
 <code lang="squirrel">
 function onPlayerCommand( player, command, text )
 {
- if ( command == "cinema" ) SetCinematicView( true );
+    if ( command == "cinema" ) SetCinematicBorder( true );
+    return 1;
 }
 </code>
@@ Line 19: / Line 28: @@
 === Notes ===
-This will turn the cinematic view for all players on.
+The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in this example. More info about it in the corresponding page.
 == Related Functions ==
 {{Squirrel/Server/Functions/Camera}}