WorldData
in
Table of Contents
- getDifficulty() : int
- Returns the world difficulty. This will be one of the World constants.
- getGenerator() : string
- Returns the generator name
- getGeneratorOptions() : string
- getLightningLevel() : float
- getLightningTime() : int
- Returns the time in ticks to the next lightning level change.
- getName() : string
- getRainLevel() : float
- getRainTime() : int
- Returns the time in ticks to the next rain level change.
- getSeed() : int
- getSpawn() : Vector3
- getTime() : int
- save() : void
- Saves information about the world state, such as weather, time, etc.
- setDifficulty() : void
- Sets the world difficulty.
- setLightningLevel() : void
- setLightningTime() : void
- Sets the time in ticks to the next lightning level change.
- setRainLevel() : void
- setRainTime() : void
- Sets the time in ticks to the next rain level change.
- setSpawn() : void
- setTime() : void
Methods
getDifficulty()
Returns the world difficulty. This will be one of the World constants.
public
getDifficulty() : int
Return values
int —getGenerator()
Returns the generator name
public
getGenerator() : string
Return values
string —getGeneratorOptions()
public
getGeneratorOptions() : string
Return values
string —getLightningLevel()
public
getLightningLevel() : float
Return values
float —0.0 - 1.0
getLightningTime()
Returns the time in ticks to the next lightning level change.
public
getLightningTime() : int
Return values
int —getName()
public
getName() : string
Return values
string —getRainLevel()
public
getRainLevel() : float
Return values
float —0.0 - 1.0
getRainTime()
Returns the time in ticks to the next rain level change.
public
getRainTime() : int
Return values
int —getSeed()
public
getSeed() : int
Return values
int —getSpawn()
public
getSpawn() : Vector3
Return values
Vector3 —getTime()
public
getTime() : int
Return values
int —save()
Saves information about the world state, such as weather, time, etc.
public
save() : void
Return values
void —setDifficulty()
Sets the world difficulty.
public
setDifficulty(int $difficulty) : void
Parameters
- $difficulty : int
Return values
void —setLightningLevel()
public
setLightningLevel(float $level) : void
Parameters
- $level : float
-
0.0 - 1.0
Return values
void —setLightningTime()
Sets the time in ticks to the next lightning level change.
public
setLightningTime(int $ticks) : void
Parameters
- $ticks : int
Return values
void —setRainLevel()
public
setRainLevel(float $level) : void
Parameters
- $level : float
-
0.0 - 1.0
Return values
void —setRainTime()
Sets the time in ticks to the next rain level change.
public
setRainTime(int $ticks) : void
Parameters
- $ticks : int
Return values
void —setSpawn()
public
setSpawn(Vector3 $pos) : void
Parameters
- $pos : Vector3
Return values
void —setTime()
public
setTime(int $value) : void
Parameters
- $value : int