Squirrel/Server/Functions/Camera/GetCinematicBorder
From Liberty Unleashed Wiki
(Difference between revisions)
m |
|||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{Squirrel/Title|GetCinematicBorder}} | |
| − | This function will return a boolean value of either true or false. | + | 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 == | == Syntax == | ||
| − | '' | + | <code>bool GetCinematicBorder( [ Player plr ] )</code> |
| + | |||
| + | == Arguments == | ||
| + | |||
| + | * '''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 | ||
== Example == | == Example == | ||
| + | |||
| + | This example returns whether the cinematic border is in use globally when a player types '/cinema'. | ||
<code lang="squirrel"> | <code lang="squirrel"> | ||
function onPlayerCommand( player, command, text ) | function onPlayerCommand( player, command, text ) | ||
{ | { | ||
| − | + | if ( command == "cinema" ) MessagePlayer( "Cinematic border is currently set to " + GetCinematicBorder(), player ); | |
| + | |||
| + | return 1; | ||
} | } | ||
</code> | </code> | ||
| Line 18: | Line 26: | ||
This is useful for checking that the cinematic border isn't already active before setting it to true. | This is useful for checking that the cinematic border isn't already active before setting it to true. | ||
| + | |||
| + | The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages. | ||
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Camera}} | {{Squirrel/Server/Functions/Camera}} | ||
Latest revision as of 02:37, 25 September 2010
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.
[edit] Syntax
[edit] Arguments
- 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
[edit] Example
This example returns whether the cinematic border is in use globally when a player types '/cinema'.
[edit] 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 this example. More info about them in the corresponding pages.
[edit] Related Functions
- FadeCamera
- GetCinematicBorder
- RestoreCamera
- ShakeCamera
- SetCameraMatrix
- SetCinematicBorder
