SetWorldSpecialPropertyEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(24 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{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'''", "'''extendedwatercannons'''" to avoid possible data desynchronization.
}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool setWorldSpecialPropertyEnabled ( string propname, bool enable )</syntaxhighlight>
<syntaxhighlight lang="lua">bool setWorldSpecialPropertyEnabled ( string propname, bool enable )</syntaxhighlight>
{{OOP||||isWorldSpecialPropertyEnabled}}
{{OOP||||isWorldSpecialPropertyEnabled}}
 
[[File:Randomfoliage.jpeg|frame|right|A photo demonstrating ''randomfoliage'' enabled and disabled.]]
[[File:Roadsignstext.png|frame|right|A photo demonstrating ''roadsignstext'' enabled and disabled.]]
[[File:Extendedwatercannons.png|frame|right|A photo demonstrating ''extendedwatercannons'' enabled and disabled.]]
===Required Arguments===
===Required Arguments===
*'''propname:''' the name of the property to set. Possible values are:
*'''propname:''' the name of the property to set. Possible values are:
**'''hovercars''' - equivalent of the JBGVNB cheat, and allows cars to drive on water.
**'''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.
**'''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.
**'''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.
**'''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) [https://wiki.multitheftauto.com/wiki/File:Randomfoliage.jpeg Image]
**'''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)
**'''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)
**'''extraairresistance''' - toggle the vehicle speed limit on cross-country roads (default: true)
**{{New feature/item|3.0156|1.5.5|12286|'''underworldwarp''' - toggle warp of peds and vehicles when fall under map (default: true)}}
**{{New feature/item|3.0156|1.5.5|12286|'''underworldwarp''' - toggle warp of peds and vehicles when fall under map (default: true)}}
**{{New feature/item|3.0160|1.5.9|21125|'''vehiclesunglare''' - toggle the vehicle sun glare effect (default: false) }}
**{{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|22195| '''burnflippedcars''' - toggle the vehicle to burn when upside down (default: true) }}
**{{New feature/item|3.0161|1.6.0|22199| '''fireballdestruct''' - toggle the aircraft model destruction on explosion ([[Media:FireballDestruct.jpg|preview]]) (default: true) }}
**{{New feature/item|3.0161|1.6.0|22430| '''roadsignstext''' - toggle the drawing of text on road signs. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22485| '''extendedwatercannons''' - Increases the default limit of water cannons used at the same time from 3 to 30. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22596| '''tunnelweatherblend''' - toggle the weather blending effect when the player is in the tunnel. (default: true)}}
*'''enable:''' whether or not to enable the property.
*'''enable:''' whether or not to enable the property.


Line 25: Line 41:
==Example==
==Example==


'''Example 1:''' Allows cars to fly.
This code allows you to enable/disable certain property using '''true''' or '''false'''.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", resourceRoot,
function onClientResourceStart()
    function( )
local worldSpecialProperties = {
        setWorldSpecialPropertyEnabled( "aircars", true )
["hovercars"] = false,
    end
["aircars"] = false,
)
["extrabunny"] = false,
["extrajump"] = false,
["randomfoliage"] = true,
["snipermoon"] = false,
["extraairresistance"] = true,
["underworldwarp"] = true,
["vehiclesunglare"] = false,
["coronaztest"] = true,
["watercreatures"] = true,
["burnflippedcars"] = true,
["fireballdestruct"] = true,
["roadsignstext"] = true,
["extendedwatercannons"] = true,
["tunnelweatherblend"] = true,
}
for propertyName, propertyState in pairs(worldSpecialProperties) do
setWorldSpecialPropertyEnabled(propertyName, propertyState)
end
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart)
</syntaxhighlight>
</syntaxhighlight>
'''Example 2:''' Allow cars to drive on water.
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", resourceRoot,
    function( )
        setWorldSpecialPropertyEnabled( "hovercars", true )
    end
)</syntaxhighlight>


==Changelog==
==Changelog==
{{ChangelogHeader}}
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.12286|Added "underworldwarp" property}}
{{ChangelogItem|1.5.5-3.12286|Added "underworldwarp" property}}
{{ChangelogItem|1.5.9-1.21125|Added "vehiclesunglare" property}}
{{ChangelogItem|1.5.9-9.21313|Added "coronaztest" property}}
{{ChangelogItem|1.6.0-9.21919|Added "watercreatures" property}}
{{ChangelogItem|1.6.0-9.22195|Added "burnflippedcars" property}}
{{ChangelogItem|1.6.0-9.22199|Added "fireballdestruct" property}}
{{ChangelogItem|1.6.0-9.22430|Added "roadsignstext" property}}
{{ChangelogItem|1.6.0-9.22485|Added "extenedwatercannons" property}}
{{ChangelogItem|1.6.0-9.22596|Added "tunnelweatherblend" property}}


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

Latest revision as of 15:45, 11 September 2024

ADDED/UPDATED IN VERSION 1.6.0 r22195:
Added also as a server-side function. Previously only available as a client-side function.

Enables or disables a special world property.

[[{{{image}}}|link=|]] Note:

It's recommended to use server-side function with appropriate minclientversion for properties like "underworldwarp", "burnflippedcars", "extendedwatercannons" 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.
A photo demonstrating roadsignstext enabled and disabled.
A photo demonstrating extendedwatercannons 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)
    • ADDED/UPDATED IN VERSION 1.6.0 r21919:
      watercreatures - toggle randomly generated underwater creatures (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22195:
      burnflippedcars - toggle the vehicle to burn when upside down (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22199:
      fireballdestruct - toggle the aircraft model destruction on explosion (preview) (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22430:
      roadsignstext - toggle the drawing of text on road signs. (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22485:
      extendedwatercannons - Increases the default limit of water cannons used at the same time from 3 to 30. (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22596:
      tunnelweatherblend - toggle the weather blending effect when the player is in the tunnel. (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,
		["fireballdestruct"] = true,
		["roadsignstext"] = true,
		["extendedwatercannons"] = true,
		["tunnelweatherblend"] = 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
1.6.0-9.22199 Added "fireballdestruct" property
1.6.0-9.22430 Added "roadsignstext" property
1.6.0-9.22485 Added "extenedwatercannons" property
1.6.0-9.22596 Added "tunnelweatherblend" property

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetWorldSpecialPropertyEnabled?oldid=80491"