Squirrel/Server/Functions/Camera/SetCinematicBorder
From Liberty Unleashed Wiki
(Difference between revisions)
(New page: __NOTOC__ This function will activate/deactive the cinematic border. == Syntax == ''SetCinematicBorder'' can take one parameter, this is: <code>bool SetCinematicBorder( bool true/false ...) |
|||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
− | This function will activate/deactive the cinematic border. | + | This function will activate/deactive the cinematic border (widescreen effect). |
== Syntax == | == Syntax == | ||
− | + | <code>bool SetCinematicBorder( bool enabled )</code> | |
− | + | == Arguments == | |
+ | |||
+ | * '''enabled''' - true/false to enable/disable the cinematic border | ||
== Example == | == Example == | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
+ | |||
+ | This will turn the cinematic view for all players on when someone types '/cinema'. | ||
+ | |||
function onPlayerCommand( player, command, text ) | function onPlayerCommand( player, command, text ) | ||
{ | { | ||
Line 19: | Line 24: | ||
=== Notes === | === Notes === | ||
− | + | The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in in this example. More info about it in the corresponding page. | |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Camera}} | {{Squirrel/Server/Functions/Camera}} |
Revision as of 16:56, 7 January 2010
This function will activate/deactive the cinematic border (widescreen effect).
Syntax
bool SetCinematicBorder( bool enabled )
Arguments
- enabled - true/false to enable/disable the cinematic border
Example
This will turn the cinematic view for all players on when someone types '/cinema'. function onPlayerCommand( player, command, text ) { if ( command == "cinema" ) SetCinematicView( true ); }
Notes
The event onPlayerCommand was used in in this example. More info about it in the corresponding page.
Related Functions
- FadeCamera
- GetCinematicBorder
- RestoreCamera
- ShakeCamera
- SetCameraMatrix
- SetCinematicBorder