SetWaterColor

From Multi Theft Auto: Wiki
Revision as of 17:42, 3 May 2009 by Awwu (talk | contribs) (New page: __NOTOC__ {{Client function}} This function changes the water color of the GTA world. ==Syntax== <syntaxhighlight lang="lua"> bool setWaterColor ( int red, int blue, int green, [ int alpha = 200 ] ) </c...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function changes the water color of the GTA world.

Syntax

bool setWaterColor ( int red, int blue, int green, [ int alpha = 200 ] )

Required Arguments

  • red: The red value of the water, from 0 to 255.
  • breen: The green value of the water, from 0 to 255.
  • blue: The blue value of the water, from 0 to 255.

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.

  • alpha: The alpha (visibility) value of the water, from 0 to 255. Defaults to 200 if not declared.

Returns

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

Example

This example adds a command watercolor with which a player can change the water colour. 

function changeWaterColor ( commandName, red, green, blue, alpha )
    -- if alpha is input, then include it too
    alpha = alpha or 200
    -- check if the colour values for red, green and blue are valid
    if tonumber ( red ) and tonumber ( green ) and tonumber ( blue ) then
        setWaterColor ( red, green, blue, alpha )
    else
        outputChatBox ( "Failed to change the water colour!" )
    end
end
addCommandHandler ( "watercolor", changeWaterColor )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetWaterColor?oldid=19400"