SetWaterLevel - Revision history

Zangomangu: remove deprecated syntax

2023-10-22T23:09:09Z

remove deprecated syntax

← Older revision		Revision as of 23:09, 22 October 2023
Line 9:		Line 9:
	</syntaxhighlight>		</syntaxhighlight>

	~~{{Deprecated items\|3.0159\|1.5.8\|~~
	~~<syntaxhighlight lang="lua">~~
	~~bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )~~
	~~</syntaxhighlight>~~
	~~\|20716}}~~
	{{Added feature/item\|1.5.9\|1.5.8\|20716\|		{{Added feature/item\|1.5.9\|1.5.8\|20716\|
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Lvrent at 21:36, 23 September 2021

2021-09-23T21:36:10Z

← Older revision		Revision as of 21:36, 23 September 2021
Line 14:		Line 14:
	</syntaxhighlight>		</syntaxhighlight>
	\|20716}}		\|20716}}
	{{~~New~~ feature/item\|3.~~0159~~\|1.5.8\|20716\|		{{Added feature/item\|1.5.9\|1.5.8\|20716\|
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true, bool includeWorldSea = true, bool includeOutsideWorldSea = false ] )		bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true, bool includeWorldSea = true, bool includeOutsideWorldSea = false ] )
Line 32:		Line 32:
	*'''includeWaterFeatures :''' a boolean indicating whether to also set the level of water features such as ponds and pools.		*'''includeWaterFeatures :''' a boolean indicating whether to also set the level of water features such as ponds and pools.
	*'''includeWaterElements :''' a boolean indicating whether to also set the level of all water elements.		*'''includeWaterElements :''' a boolean indicating whether to also set the level of all water elements.
	{{~~New~~ feature/item\|3.~~0159~~\|1.5.8\|20716\|		{{Added feature/item\|1.5.9\|1.5.8\|20716\|
	*'''includeWorldSea :''' a boolean indicating whether to set the level of the sea water		*'''includeWorldSea :''' a boolean indicating whether to set the level of the sea water
	*'''includeOutsideWorldSea:''' a boolean indicating whether to also set the level of sea water outside the world area, ie. outside -3000, 3000.		*'''includeOutsideWorldSea:''' a boolean indicating whether to also set the level of sea water outside the world area, ie. outside -3000, 3000.

Myonlake at 11:42, 11 April 2021

2021-04-11T11:42:39Z

← Older revision		Revision as of 11:42, 11 April 2021
Line 32:		Line 32:
	*'''includeWaterFeatures :''' a boolean indicating whether to also set the level of water features such as ponds and pools.		*'''includeWaterFeatures :''' a boolean indicating whether to also set the level of water features such as ponds and pools.
	*'''includeWaterElements :''' a boolean indicating whether to also set the level of all water elements.		*'''includeWaterElements :''' a boolean indicating whether to also set the level of all water elements.
	{{New feature/item\|3.~~0160~~\|1.5.8\|20716\|		{{New feature/item\|3.0159\|1.5.8\|20716\|
	*'''includeWorldSea :''' a boolean indicating whether to set the level of the sea water		*'''includeWorldSea :''' a boolean indicating whether to set the level of the sea water
	*'''includeOutsideWorldSea:''' a boolean indicating whether to also set the level of sea water outside the world area, ie. outside -3000, 3000.		*'''includeOutsideWorldSea:''' a boolean indicating whether to also set the level of sea water outside the world area, ie. outside -3000, 3000.

Myonlake at 11:30, 11 April 2021

2021-04-11T11:30:38Z

← Older revision		Revision as of 11:30, 11 April 2021
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setWaterLevel ( [water theWater,] float level )		bool setWaterLevel ( [ water theWater, ] float level )
	</syntaxhighlight>		</syntaxhighlight>

			{{Deprecated items\|3.0159\|1.5.8\|
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )		bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{New feature/item\|3.~~0160~~\|1.5.8\|20716\|		\|20716}}
			{{New feature/item\|3.0159\|1.5.8\|20716\|
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true, bool includeWorldSea = true, bool includeOutsideWorldSea = false ] )		bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true, bool includeWorldSea = true, bool includeOutsideWorldSea = false ] )

Zangomangu at 16:52, 28 November 2020

2020-11-28T16:52:50Z

← Older revision		Revision as of 16:52, 28 November 2020
Line 11:		Line 11:
	bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )		bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{New feature/item\|3.0160\|1.5.8\|20716\|
			<syntaxhighlight lang="lua">
			bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true, bool includeWorldSea = true, bool includeOutsideWorldSea = false ] )
			</syntaxhighlight>
			}}

	{{OOP\|\|[[water]]:setLevel\|level\|getWaterLevel}}		{{OOP\|\|[[water]]:setLevel\|level\|getWaterLevel}}
Line 24:		Line 29:
	*'''includeWaterFeatures :''' a boolean indicating whether to also set the level of water features such as ponds and pools.		*'''includeWaterFeatures :''' a boolean indicating whether to also set the level of water features such as ponds and pools.
	*'''includeWaterElements :''' a boolean indicating whether to also set the level of all water elements.		*'''includeWaterElements :''' a boolean indicating whether to also set the level of all water elements.
			{{New feature/item\|3.0160\|1.5.8\|20716\|
			*'''includeWorldSea :''' a boolean indicating whether to set the level of the sea water
			*'''includeOutsideWorldSea:''' a boolean indicating whether to also set the level of sea water outside the world area, ie. outside -3000, 3000.
			}}
	}}		}}

Line 82:		Line 91:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	~~==Issues==~~
	~~{{Issues\|~~
	~~{{Issue\|7542\|Water functions in general do not work outside the -3000 -3000 3000 3000 bounds}}~~
	}}

	==See Also==		==See Also==
	{{Client water functions}}		{{Client water functions}}

Qaisjp: clean page up & fix oop

2016-08-07T15:11:52Z

clean page up & fix oop

← Older revision		Revision as of 15:11, 7 August 2016
Line 5:		Line 5:
	{{Note\|When the water level is 0, the standard GTA rendering is performed so that water is visible when viewed through translucent surfaces, such as vehicle windows. However, some MTA custom objects placed underwater will appear in front of the water. Setting the water level to any non-zero value (i.e. setWaterLevel(0.001) ) forces alternative rendering and MTA custom objects placed underwater will be drawn correctly.}}		{{Note\|When the water level is 0, the standard GTA rendering is performed so that water is visible when viewed through translucent surfaces, such as vehicle windows. However, some MTA custom objects placed underwater will appear in front of the water. Setting the water level to any non-zero value (i.e. setWaterLevel(0.001) ) forces alternative rendering and MTA custom objects placed underwater will be drawn correctly.}}
	==Syntax==		==Syntax==
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setWaterLevel ( [water theWater,] float level )		bool setWaterLevel ( [water theWater,] float level )
Line 13:		Line 12:
	</syntaxhighlight>		</syntaxhighlight>

	{{OOP\|\|[[water]]:setLevel\|level\|~~resetWaterLevel~~}}		{{OOP\|\|[[water]]:setLevel\|level\|getWaterLevel}}

	===Required Arguments===		===Required Arguments===
Line 29:		Line 28:
	===Returns===		===Returns===
	Returns ''true'' if successful, ''false'' in case of failure.		Returns ''true'' if successful, ''false'' in case of failure.
	~~</section>~~

	~~<section name="Client" class="client" show="true">~~
	~~<syntaxhighlight lang="lua">bool setWaterLevel ( [float x, float y, float z,] float level )~~
	~~bool setWaterLevel ( [water theWater,] float level )~~
	~~bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )</syntaxhighlight>~~

			== Alternate client-only syntax ==
			<section name="Client only" class="client" show="true">
			<syntaxhighlight lang="lua">bool setWaterLevel ( [float x, float y, float z,] float level )</syntaxhighlight>
	===Required Arguments===		===Required Arguments===
	*'''level:''' the new Z coordinate of the water surface~~. If '''x''', '''y''' and '''z''', or '''water''', are specified, the~~ area of water containing that point or corresponding to that water element ~~is changed. Otherwise, all water in the game world~~ is changed.		*'''level:''' the new Z coordinate of the water surface
			===Optional Arguments===
			The area of water containing that point or corresponding to that water element is changed.

	~~===Optional Arguments===~~
	*'''x:''' the X coordinate of the point indicating the water area to change.		*'''x:''' the X coordinate of the point indicating the water area to change.
	*'''y:''' the Y coordinate of the point indicating the water area to change.		*'''y:''' the Y coordinate of the point indicating the water area to change.
	*'''z:''' the Z coordinate of the point indicating the water area to change. This parameter is reserved and is currently ignored, set it to 0.		*'''z:''' the Z coordinate of the point indicating the water area to change. This parameter is reserved and is currently ignored, set it to 0.

	~~''or:''~~
	*'''theWater:''' the water element to change.

	~~''or:''~~
	~~{{New feature/item\|3.0120\|1.2\|\|~~
	*'''includeWaterFeatures :''' a boolean indicating whether to also set the level of water features such as ponds and pools.
	*'''includeWaterElements :''' a boolean indicating whether to also set the level of all water elements.
	}}

	===Returns===		===Returns===

Qaisjp: fix oop

2016-08-07T14:11:15Z

fix oop

← Older revision		Revision as of 14:11, 7 August 2016
Line 13:		Line 13:
	</syntaxhighlight>		</syntaxhighlight>

	{{OOP\|\|[[water]]:setLevel\|~~setLevel~~\|resetWaterLevel}}		{{OOP\|\|[[water]]:setLevel\|level\|resetWaterLevel}}

	===Required Arguments===		===Required Arguments===

Walid: Added oop syntax

2016-08-06T17:55:43Z

Added oop syntax

← Older revision		Revision as of 17:55, 6 August 2016
Line 12:		Line 12:
	bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )		bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )
	</syntaxhighlight>		</syntaxhighlight>

			{{OOP\|\|[[water]]:setLevel\|setLevel\|resetWaterLevel}}

	===Required Arguments===		===Required Arguments===

LuXorioN: Fixxed Bot Section

2014-11-18T08:20:48Z

Fixxed Bot Section

← Older revision		Revision as of 08:20, 18 November 2014
Line 8:		Line 8:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setWaterLevel ( [water theWater,] float level )		bool setWaterLevel ( [water theWater,] float level )
			</syntaxhighlight>
			<syntaxhighlight lang="lua">
	bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )		bool setWaterLevel ( float level [, bool includeWaterFeatures = true, bool includeWaterElements = true ] )
	</syntaxhighlight>		</syntaxhighlight>

Arran Fortuna at 17:27, 9 April 2014

2014-04-09T17:27:34Z

← Older revision		Revision as of 17:27, 9 April 2014
Line 90:		Line 90:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

			==Issues==
			{{Issues\|
			{{Issue\|7542\|Water functions in general do not work outside the -3000 -3000 3000 3000 bounds}}
			}}

	==See Also==		==See Also==
	{{Client water functions}}		{{Client water functions}}