GetWorldProperty

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

ADDED/UPDATED IN VERSION 1.6.0 r22592:
This function is used to get the values of time cycle and weather related properties.

Syntax

mixed getWorldProperty ( string property )

OOP Syntax Help! I don't understand this!

Counterpart: setWorldProperty


Required Arguments

  • property: The property you wish to retrieve.
Property Type Description
AmbientColor RGB The color of ambient light on map objects (including custom objects)
AmbientObjColor RGB The color of ambient light on dynamically created elements (peds, vehicles)
DirectionalColor RGB The color of direct light on dynamically created elements (peds, vehicles)
Illumination FLOAT Multiplier for the directional light (DirectionalColor)
SpriteSize FLOAT Point lights corona size (traffic lights)
SpriteBrightness FLOAT Point lights corona brightness (also affects light on ground for light poles)
LightsOnGround FLOAT Point lights ground reflection brightness (traffic lights)
PoleShadowStrength INT Pole shadows alpha (used if volumetric shadows are disabled)
ShadowStrength INT Shadows alpha (all shadows)
ShadowsOffset FLOAT Shadows height
BottomCloudsColor RGB Bottom (normal) clouds color
CloudsAlpha INT Bottom (normal) clouds alpha
LowCloudsColor RGB Low (skyline) clouds color (dependent on game hours)
WetRoads FLOAT Wet roads weather effect (noticeable during driving)
Turns on lights on ground during daytime
Foggyness FLOAT Adds light fog effect for headlights and turns on lights on ground during daytime
Also affects skyline clouds and shadows visibility
Fog FLOAT Fog weather effect alpha
RainFog FLOAT Rain fog weather effect alpha (different fog; used in rain weathers) (reset is smooth)
WaterFog FLOAT Water fog alpha
Rainbow FLOAT Rainbow alpha
Sandstorm FLOAT Sandstorm sound volume (reset is smooth)

Returns

Returns the value of property represented by either 1 or 3 numbers (RGB, FLOAT, INT) if successful, false otherwise.

Example

This example prints the value of AmbientColor: 

local r, g, b = getWorldProperty("AmbientColor")
outputChatBox("Ambient Color: "..table.concat({r, g, b}, ", "))

Requirements

Minimum server version n/a
Minimum client version 1.6.0-9.22592

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.6.0-9.22592" />

See Also

Shared


Retrieved from "https://wiki.multitheftauto.com/wiki/GetWorldProperty?oldid=79737"