SetWorldSpecialPropertyEnabled: Difference between revisions
Jump to navigation
Jump to search
(Add "watercreatures" property) |
(Added to server-side + "burnflippedcars" property) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{ | {{Shared function}} | ||
{{New feature/item|3.0161|1.6.0|22195|Added also as a server-side function. Previously only available as a client-side function.}} | |||
Enables or disables a special world property. | Enables or disables a special world property. | ||
{{Note| | |||
It's recommended to use server-side function with appropriate [[mtaserver.conf#minclientversion|minclientversion]] for properties like "'''underworldwarp'''", "'''burnflippedcars'''" to avoid possible data desynchronization. | |||
}} | |||
==Syntax== | ==Syntax== | ||
| Line 21: | Line 27: | ||
**{{New feature/item|3.0160|1.5.9|21313| '''coronaztest''' - disable big sun lensflare effect (default: true) }} | **{{New feature/item|3.0160|1.5.9|21313| '''coronaztest''' - disable big sun lensflare effect (default: true) }} | ||
**{{New feature/item|3.0161|1.6.0|21919| '''watercreatures''' - toggle randomly generated underwater creatures (default: true) }} | **{{New feature/item|3.0161|1.6.0|21919| '''watercreatures''' - toggle randomly generated underwater creatures (default: true) }} | ||
**{{New feature/item|3.0161|1.6.0|22195| '''burnflippedcars''' - toggle the vehicle to burn when upside down (default: true) }} | |||
*'''enable:''' whether or not to enable the property. | *'''enable:''' whether or not to enable the property. | ||
| Line 43: | Line 50: | ||
["coronaztest"] = true, | ["coronaztest"] = true, | ||
["watercreatures"] = true, | ["watercreatures"] = true, | ||
["burnflippedcars"] = true, | |||
} | } | ||
| Line 58: | Line 66: | ||
{{ChangelogItem|1.5.9-9.21313|Added "coronaztest" property}} | {{ChangelogItem|1.5.9-9.21313|Added "coronaztest" property}} | ||
{{ChangelogItem|1.6.0-9.21919|Added "watercreatures" property}} | {{ChangelogItem|1.6.0-9.21919|Added "watercreatures" property}} | ||
{{ChangelogItem|1.6.0-9.22195|Added "burnflippedcars" property}} | |||
==See Also== | ==See Also== | ||
{{ | {{Shared world functions}} | ||
Revision as of 08:32, 9 September 2023
Enables or disables a special world property.
| Note:
It's recommended to use server-side function with appropriate minclientversion for properties like "underworldwarp", "burnflippedcars" to avoid possible data desynchronization. |
Syntax
bool setWorldSpecialPropertyEnabled ( string propname, bool enable )
OOP Syntax Help! I don't understand this!
- Counterpart: isWorldSpecialPropertyEnabled
A photo demonstrating randomfoliage enabled and disabled.
Required Arguments
- propname: the name of the property to set. Possible values are:
- hovercars - equivalent of the JBGVNB cheat, and allows cars to drive on water. (default: false)
- aircars - equivalent of the RIPAZHA cheat, and allows cars to fly. (default: false)
- extrabunny - equivalent of the CJPHONEHOME or JHJOECW cheat, and allows you to bunny hop on bicycles much higher. (default: false)
- extrajump - equivalent of the KANGAROO cheat, and allows you to jump on foot much higher. (default: false)
- randomfoliage - toggle randomly generated foliage on the GTA:SA map (default: true)
- snipermoon - toggle the GTA:SA easter egg, which increases the size of the moon every time you shoot it with a sniper rifle (default: false)
- extraairresistance - toggle the vehicle speed limit on cross-country roads (default: true)
- underworldwarp - toggle warp of peds and vehicles when fall under map (default: true)
- vehiclesunglare - toggle the vehicle sun glare effect (default: false)
- coronaztest - disable big sun lensflare effect (default: true)
- enable: whether or not to enable the property.
Returns
Returns true if successful, false otherwise.
Example
This code allows you to enable/disable certain property using true or false.
function onClientResourceStart()
local worldSpecialProperties = {
["hovercars"] = false,
["aircars"] = false,
["extrabunny"] = false,
["extrajump"] = false,
["randomfoliage"] = true,
["snipermoon"] = false,
["extraairresistance"] = true,
["underworldwarp"] = true,
["vehiclesunglare"] = false,
["coronaztest"] = true,
["watercreatures"] = true,
["burnflippedcars"] = true,
}
for propertyName, propertyState in pairs(worldSpecialProperties) do
setWorldSpecialPropertyEnabled(propertyName, propertyState)
end
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart)
Changelog
| Version | Description |
|---|
| 1.5.5-3.12286 | Added "underworldwarp" property |
| 1.5.9-1.21125 | Added "vehiclesunglare" property |
| 1.5.9-9.21313 | Added "coronaztest" property |
| 1.6.0-9.21919 | Added "watercreatures" property |
| 1.6.0-9.22195 | Added "burnflippedcars" property |
See Also
- areTrafficLightsLocked
- getAircraftMaxVelocity
- getCloudsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGravity
- getHeatHaze
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getOcclusionsEnabled
- getRainLevel
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getWeather
- getWindVelocity
- isWorldSpecialPropertyEnabled
- getZoneName
- isGarageOpen
- removeWorldModel
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetWindVelocity
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxVelocity
- setCloudsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorSoundsEnabled
- setMinuteDuration
- setMoonSize
- setOcclusionsEnabled
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightState
- setTrafficLightsLocked
- setWeather
- setWeatherBlended
- setWindVelocity
- setWorldSpecialPropertyEnabled