SetSkyGradient: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Minor changes)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Client function}}
This function changes the sky color to a gradient.
This function changes the sky color to a two-color gradient.


==Syntax==  
==Syntax==  
Line 10: Line 10:
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
*'''topRed:''' The ''red'' value of the upper part of the sky.
*'''topRed:''' The ''red'' value of the upper part of the sky, from 0 to 255.
*'''topGreen:''' The ''green'' value of the upper part of the sky.
*'''topGreen:''' The ''green'' value of the upper part of the sky, from 0 to 255.
*'''topBlue:''' The ''blue'' value of the upper part of the sky.
*'''topBlue:''' The ''blue'' value of the upper part of the sky, from 0 to 255.
*'''bottomRed:''' The ''red'' value of the lower part of the sky.
*'''bottomRed:''' The ''red'' value of the lower part of the sky, from 0 to 255.
*'''bottomGreen:''' The ''green'' value of the lower part of the sky.
*'''bottomGreen:''' The ''green'' value of the lower part of the sky, from 0 to 255.
*'''bottomBlue:''' The ''blue'' value of the lower part of the sky.
*'''bottomBlue:''' The ''blue'' value of the lower part of the sky, from 0 to 255.


===Returns===
===Returns===
Returns ''true'' if sky color was set correctly, ''false'' if the values go beyond 0 to 255, or are not numeric.
Returns ''true'' if sky color was set correctly, ''false'' if invalid values were passed.


==Example==  
==Example==  
Line 28: Line 28:
==See Also==
==See Also==
{{Client world functions}}
{{Client world functions}}
[[Category:Incomplete]]

Revision as of 14:52, 26 August 2007

This function changes the sky color to a two-color gradient.

Syntax

bool setSkyGradient ( [ int topRed = 0, int topGreen = 0, int topBlue = 0, int bottomRed = 0, int bottomGreen = 0, int bottomBlue = 0 ] )

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • topRed: The red value of the upper part of the sky, from 0 to 255.
  • topGreen: The green value of the upper part of the sky, from 0 to 255.
  • topBlue: The blue value of the upper part of the sky, from 0 to 255.
  • bottomRed: The red value of the lower part of the sky, from 0 to 255.
  • bottomGreen: The green value of the lower part of the sky, from 0 to 255.
  • bottomBlue: The blue value of the lower part of the sky, from 0 to 255.

Returns

Returns true if sky color was set correctly, false if invalid values were passed.

Example

This example sets the sky to a hot pink color. 

setSkyGradient( 200, 0, 100, 200, 0, 100 )

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetSkyGradient?oldid=11377"