noppes.npcs.scripted

Class ScriptWorld

java.lang.Object

noppes.npcs.scripted.ScriptWorld

public class ScriptWorld
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScriptWorld(net.minecraft.world.WorldServer world)

Method Summary

Modifier and Type	Method and Description
void	clearStoredData() Remove all stored data
void	clearTempData() Removes all tempdata
ScriptItemStack	createItem(java.lang.String id, int damage, int size)
void	explode(double x, double y, double z, float range, boolean fire, boolean grief)
ScriptPlayer[]	getAllServerPlayers()
java.lang.String	getBiomeName(int x, int z)
ScriptItemStack	getBlock(int x, int y, int z)
net.minecraft.world.World	getMCWorld()
ScriptPlayer	getPlayer(java.lang.String name)
ScriptScoreboard	getScoreboard()
java.lang.String	getSignText(int x, int y, int z)
java.lang.Object	getStoredData(java.lang.String key)
java.lang.Object	getTempData(java.lang.String key)
long	getTime()
long	getTotalTime()
boolean	hasStoredData(java.lang.String key)
boolean	hasTempData(java.lang.String key)
boolean	isDay()
boolean	isRaining()
void	removeBlock(int x, int y, int z)
void	removeStoredData(java.lang.String key)
void	removeTempData(java.lang.String key)
void	setBlock(int x, int y, int z, ScriptItemStack item)
void	setRaining(boolean bo)
void	setStoredData(java.lang.String key, java.lang.Object value) Stored data persists through world restart.
void	setTempData(java.lang.String key, java.lang.Object value) Tempdata gets cleared when the server restarts.
void	setTime(long time)
ScriptEntity	spawnClone(int x, int y, int z, int tab, java.lang.String name) Lets you spawn a server side cloned entity
void	spawnParticle(java.lang.String particle, double x, double y, double z, double dx, double dy, double dz, double speed, int count) Sends a packet from the server to the client everytime its called.
void	thunderStrike(double x, double y, double z)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptWorld

public ScriptWorld(net.minecraft.world.WorldServer world)

Method Detail

getTime

public long getTime()

Returns:

The worlds time

getTotalTime

public long getTotalTime()

Returns:

The total world time

getBlock

public ScriptItemStack getBlock(int x,
                                int y,
                                int z)

Parameters:

x - World position x

y - World position y

z - World position z

Returns:

The block at the given position. Returns null if there isn't a block

getSignText

public java.lang.String getSignText(int x,
                                    int y,
                                    int z)

Parameters:

x - World position x

y - World position y

z - World position z

Returns:

Text from signs

Since:

1.7.10d

setBlock

public void setBlock(int x,
                     int y,
                     int z,
                     ScriptItemStack item)

Parameters:

x - World position x

y - World position y

z - World position z

item - The block to be set

removeBlock

public void removeBlock(int x,
                        int y,
                        int z)

Parameters:

x - World position x

y - World position y

z - World position z

getPlayer

public ScriptPlayer getPlayer(java.lang.String name)

Parameters:

name - The name of the player to be returned

Returns:

The Player with name. Null is returned when the player isnt found

setTime

public void setTime(long time)

Parameters:

time - The world time to be set

isDay

public boolean isDay()

Returns:

Whether or not its daytime

isRaining

public boolean isRaining()

Returns:

Whether or not its currently raining

setRaining

public void setRaining(boolean bo)

Parameters:

bo - Set if it's raining

thunderStrike

public void thunderStrike(double x,
                          double y,
                          double z)

Parameters:

x - The x position

y - The y position

z - The z position

spawnParticle

public void spawnParticle(java.lang.String particle,
                          double x,
                          double y,
                          double z,
                          double dx,
                          double dy,
                          double dz,
                          double speed,
                          int count)

Sends a packet from the server to the client everytime its called. Probably should not use this too much.

Parameters:

particle - Particle name. Particle name list: http://minecraft.gamepedia.com/Particles

x - The x position

y - The y position

z - The z position

dx - Usually used for the x motion

dy - Usually used for the y motion

dz - Usually used for the z motion

speed - Speed of the particles, usually between 0 and 1

count - Particle count

createItem

public ScriptItemStack createItem(java.lang.String id,
                                  int damage,
                                  int size)

Parameters:

id - The items name

damage - The damage value

size - The number of items in the item

Returns:

Returns the item

getTempData

public java.lang.Object getTempData(java.lang.String key)

Parameters:

key - Get temp data for this key

Returns:

Returns the stored temp data

setTempData

public void setTempData(java.lang.String key,
                        java.lang.Object value)

Tempdata gets cleared when the server restarts. All worlds share the same temp data.

Parameters:

key - The key for the data stored

value - The data stored

hasTempData

public boolean hasTempData(java.lang.String key)

Parameters:

key - The key thats going to be tested against the temp data

Returns:

Whether or not temp data containes the key

removeTempData

public void removeTempData(java.lang.String key)

Parameters:

key - The key for the temp data to be removed

clearTempData

public void clearTempData()

Removes all tempdata

getStoredData

public java.lang.Object getStoredData(java.lang.String key)

Parameters:

key - The key of the data to be returned

Returns:

Returns the stored data

setStoredData

public void setStoredData(java.lang.String key,
                          java.lang.Object value)

Stored data persists through world restart. Unlike tempdata only Strings and Numbers can be saved

Parameters:

key - The key for the data stored

value - The data stored. This data can be either a Number or a String. Other data is not stored

hasStoredData

public boolean hasStoredData(java.lang.String key)

Parameters:

key - The key of the data to be checked

Returns:

Returns whether or not the stored data contains the key

removeStoredData

public void removeStoredData(java.lang.String key)

Parameters:

key - The key of the data to be removed

clearStoredData

public void clearStoredData()

Remove all stored data

explode

public void explode(double x,
                    double y,
                    double z,
                    float range,
                    boolean fire,
                    boolean grief)

Parameters:

x - Position x

y - Position y

z - Position z

range - Range of the explosion

fire - Whether or not the explosion does fire damage

grief - Whether or not the explosion does damage to blocks

getAllServerPlayers

public ScriptPlayer[] getAllServerPlayers()

getBiomeName

public java.lang.String getBiomeName(int x,
                                     int z)

Parameters:

x - Position x

z - Position z

Returns:

Returns the name of the biome

Since:

1.7.10c

spawnClone

public ScriptEntity spawnClone(int x,
                               int y,
                               int z,
                               int tab,
                               java.lang.String name)

Lets you spawn a server side cloned entity

Parameters:

x - The x position the clone will be spawned at

y - The y position the clone will be spawned at

z - The z position the clone will be spawned at

tab - The tab in which the clone is

name - Name of the cloned entity

Returns:

Returns the entity which was spawned

getScoreboard

public ScriptScoreboard getScoreboard()

getMCWorld

public net.minecraft.world.World getMCWorld()

Returns:

Returns minecraft world object

Since:

1.7.10c Expert use only