Fernando187: Remove obsolete Requirements section

2024-11-07T17:35:02Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:35, 7 November 2024
Line 31:		Line 31:
	setWorldProperty("SpriteBrightness", 0)		setWorldProperty("SpriteBrightness", 0)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.6.0-9.22592\|}}~~

	==See Also==		==See Also==
	{{Client world functions}}		{{Client world functions}}

Samr46: Use Client world functions

2024-07-01T17:21:03Z

Use Client world functions

← Older revision		Revision as of 17:21, 1 July 2024
Line 36:		Line 36:

	==See Also==		==See Also==
	{{~~World~~ functions}}		{{Client world functions}}

Samr46: Add setWorldProperty

2024-06-30T15:44:54Z

Add setWorldProperty

New page

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22592|This function is used to override time cycle and weather related properties. Preview (album): https://imgur.com/a/jeUxx7L}}
{{Note|This function only adds remaining time cycle properties. You need to use existing world functions to override other properties (like sun color).}}
{{Tip|This function can be used to implement custom time cycles and other advanced weather features. It allows you to override values set by the game for weathers (timecyc.dat).
The downside of overriding is the need to implement custom blending (to change weather properties over time creating night / day cycle).}}
{{Tip|Test resource: [https://github.com/multitheftauto/mtasa-blue/files/11375576/worldprops.zip worldprops.zip]}}

==Syntax==
<syntaxhighlight lang="lua">
bool setWorldProperty ( string property, var value [, var value, var value] )
</syntaxhighlight>
{{OOP||||getWorldProperty}}
===Required Arguments===
*'''property:''' The property you wish to override.
{{World Properties}}
*'''value:''' At least one value has to be provided.

Example arguments for</br>RGB: 255, 255, 255</br>FLOAT: 0.5</br>INT: 100

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
This example makes volumetric shadows darker:
<syntaxhighlight lang="lua">
setWorldProperty("ShadowStrength", 500)
</syntaxhighlight>
This example turns off street lights:
<syntaxhighlight lang="lua">
setWorldProperty("SpriteBrightness", 0)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.6.0-9.22592|}}

==See Also==
{{World functions}}

SetWorldProperty - Revision history

Fernando187: Remove obsolete Requirements section

Samr46: Use Client world functions

Samr46: Add setWorldProperty