Squirrel/Server/Functions/Camera/FadeCamera

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
(Example)
Line 19: Line 19:
  
 
== Example ==
 
== Example ==
 
{{Squirrel/NeedsExample}}
 
 
<code lang="squirrel">
 
<code lang="squirrel">
 
function onPlayerCommand( player, cmd, text )
 
function onPlayerCommand( player, cmd, text )
Line 30: Line 28:
 
=== Notes ===
 
=== Notes ===
  
-- Example notes here
+
When used, this command would fade the camera of the player that typed "/fade".
  
 
== Related Functions ==
 
== Related Functions ==
  
 
{{Squirrel/Server/Functions/Camera}}
 
{{Squirrel/Server/Functions/Camera}}

Revision as of 20:14, 8 December 2009

This function fades the camera for the given player. It is also possible to set the fading colour.

Syntax

FadeCamera can take 3 different lists of parameters. These are:

  1. bool FadeCamera( Player plr, float speed, bool fadeIn )
  1. bool FadeCamera( Player plr, float speed, bool fadeIn, Colour col )
  1. bool FadeCamera( Player plr, float speed, bool fadeIn, int r, int g, int b )

Arguments

  • plr - This is the pointer of the player to fade the camera for
  • speed - The fading speed. The higher the value, the slower the fade
  • fadeIn - A boolean representing whether the camera should be faded in or out
  • col - A pointer to a predefined colour object to set the fade colour
  • r, g, b - Integer values for the fading colours - red, green, blue. Values range from 0 to 255

Example

  1.  
  2. function onPlayerCommand( player, cmd, text )
  3. {
  4. if ( cmd == "fade" ) FadeCamera( player );
  5. }
  6.  

Notes

When used, this command would fade the camera of the player that typed "/fade".

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox