SetSkyGradient: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Minor changes) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{ | {{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 | 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}} | ||
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
- areTrafficLightsLocked
- createSWATRope
- getAircraftMaxHeight
- getAircraftMaxVelocity
- getBirdsEnabled
- getCloudsEnabled
- getCoronaReflectionsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGarageBoundingBox
- getGaragePosition
- getGarageSize
- getGravity
- getGroundPosition
- getHeatHaze
- getInteriorFurnitureEnabled
- getInteriorSoundsEnabled
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getNearClipDistance
- getOcclusionsEnabled
- getPedsLODDistance
- getPlayerBlurLevel
- getRainLevel
- getRoofPosition
- getScreenFromWorldPosition
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getVehiclesLODDistance
- getWeather
- getWindVelocity
- getWorldFromScreenPosition
- getZoneName
- isAmbientSoundEnabled
- isGarageOpen
- isLineOfSightClear
- isWorldSoundEnabled
- isWorldSpecialPropertyEnabled
- processLineOfSight
- removeWorldModel
- resetAmbientSounds
- resetBlurLevel
- resetColorFilter
- resetCoronaReflectionsEnabled
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetNearClipDistance
- resetPedsLODDistance
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetVehiclesLODDistance
- resetWindVelocity
- resetWorldSounds
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxHeight
- setAircraftMaxVelocity
- setAmbientSoundEnabled
- setBirdsEnabled
- setCloudsEnabled
- setColorFilter
- setCoronaReflectionsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorFurnitureEnabled
- setInteriorSoundsEnabled
- setJetpackMaxHeight
- setMinuteDuration
- setMoonSize
- setNearClipDistance
- setOcclusionsEnabled
- setPedsLODDistance
- setPlayerBlurLevel
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightsLocked
- setTrafficLightState
- setVehiclesLODDistance
- setWeather
- setWeatherBlended
- setWindVelocity
- setWorldSoundEnabled
- setWorldSpecialPropertyEnabled
- testLineAgainstWater