GetCinematicBorder

From Liberty Unleashed Wiki
Revision as of 01:37, 25 September 2010 by Juppi (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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

  1. bool GetCinematicBorder( [ Player plr ] )

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

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

  1.  
  2. function onPlayerCommand( player, command, text )
  3. {
  4. if ( command == "cinema" ) MessagePlayer( "Cinematic border is currently set to " + GetCinematicBorder(), player );
  5. return 1;
  6. }
  7.  

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.

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox