SetWaterDrawnLast: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New feature/item| | |||
This function | {{New feature/item|3.0130|1.3.0|4585| | ||
This function changes the [[water]] rendering order. | |||
}} | }} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool | <syntaxhighlight lang="lua">bool setWaterDrawnLast ( bool bEnabled )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''bEnabled''': A boolean value determining water drawn last. | *'''bEnabled''': A boolean value determining whether water should be drawn last. | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if | Returns ''true'' if the rendering order was changed successfully, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example toggles water to be drawn last. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function toggleWaterDrawnLast () | |||
local bWaterDrawnLast = not isWaterDrawnLast() | |||
outputChatBox (string.format('setWaterDrawnLast: %s', tostring(bWaterDrawnLast))) | |||
return setWaterDrawnLast (bWaterDrawnLast) | |||
end | |||
addCommandHandler ('togglewater', toggleWaterDrawnLast) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Client water functions}} | {{Client water functions}} | ||
Latest revision as of 17:08, 7 November 2024
This function changes the water rendering order.
Syntax
bool setWaterDrawnLast ( bool bEnabled )
Required Arguments
- bEnabled: A boolean value determining whether water should be drawn last.
Returns
Returns true if the rendering order was changed successfully, false otherwise.
Example
This example toggles water to be drawn last.
function toggleWaterDrawnLast ()
local bWaterDrawnLast = not isWaterDrawnLast()
outputChatBox (string.format('setWaterDrawnLast: %s', tostring(bWaterDrawnLast)))
return setWaterDrawnLast (bWaterDrawnLast)
end
addCommandHandler ('togglewater', toggleWaterDrawnLast)
See Also
- getWaterLevel
- isWaterDrawnLast
- setWaterDrawnLast
- Shared
- createWater
- getWaterColor
- getWaterVertexPosition
- getWaveHeight
- resetWaterColor
- resetWaterLevel
- setWaterColor
- setWaterLevel
- setWaterVertexPosition
- setWaveHeight