Documentation

Want to improve the docs? Take a look at scripting-api-data!
Found a bug? jc3mp/bugs is a good place to let us know.

World

Constructible This class can not be instantiated from your script. Do not try to use the `new` keyword on this class. Auto Destroy Instances of this class will be deleted automatically. Custom Properties You cannot add your own properties to instances of this class. They will not be saved and can cause undefined behavior.

Class to manipulate the game world.

Properties

Name Type Description
weather number weather id (TODO: link weather types)
weatherVisible boolean
moonColor RGBA RGBA color of the moon
sunPosition Vector2f 2D position of the sun
sunHDRScale number
sunColor RGBA RGBA color of the sun
time TimeOfDay read only

Functions

World.SetTime(number hour, number minute, number p3)

Sets the local world time

Parameter

Name Type Description
hour number hour (0-24)
minute number minute (0-60)
p3 number

World.ResetSunPosition()

resets the suns position

Stay informed

By becoming the newest member of our growing forums, we and hundreds of other players will always keep you up to date on everything JC3:MP related.