TridentWorld (TridentSDK 0.4-SNAPSHOT API)

java.lang.Object
- net.tridentsdk.server.world.TridentWorld

All Implemented Interfaces:

Cloneable, World
```
@ThreadSafe
public class TridentWorld
extends Object
implements World
```
Represents a world on the server

Author:

The TridentSDK Team

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addChunkAt(ChunkLocation location, Chunk chunk)`
`Entity`	`addEntity(Entity entity)`
`Block`	`blockAt(Position location)` Gets the block on the given position
`WorldBorder`	`border()` Obtains the world border properties of this world
`TridentChunk`	`chunkAt(ChunkLocation location, boolean generateIfNotFound)` Gets the chunk on the given position, and generates the chunk if it does not exist.
`Chunk`	`chunkAt(int x, int z, boolean generateIfNotFound)` Gets the chunk on the given x and z , and generates the chunk if it does not exist
`ChunkHandler`	`chunkHandler()`
`Collection<Chunk>`	`chunks()` Obtains the loaded chunks in the world
`Set<Entity>`	`entities()` Get the entities currently in this world
`boolean`	`equals(Object obj)`
`TridentChunk`	`generateChunk(ChunkLocation location)` Generates the chunk on the given position
`Chunk`	`generateChunk(int x, int z)` Generates the chunk on the given position
`ArrayList<Entity>`	`getEntities(Entity exclude, BoundingBox boundingBox, java.util.function.Predicate<? super Entity> predicate)` Find all entities that are colliding with the bounding box
`Set<Entity>`	`internalEntities()`
`void`	`lightning(Position position, boolean b)` Strikes lightning at the given location.
`Collection<TridentChunk>`	`loadedChunks()`
`WorldLoader`	`loader()` Obtains the loading handler which created this object, passed in from the constructor
`String`	`name()` Gets the name of the world
`SoundEffect`	`playSound(SoundEffectType sound)` Creates a new sound effect
`GeneratorRandom`	`random()`
`void`	`removeEntity(Entity entity)`
`void`	`save()`
`void`	`setTime(long l)` Sets the time of the world
`WorldSettings`	`settings()` Obtains the settings which modify the behavior of the world
`Entity`	`spawn(EntityType type, Position spawnPosition)` Spawns an entity in the world
`ParticleEffect`	`spawnParticle(ParticleEffectType particle)` Creates a new particle effect
`Position`	`spawnPosition()` Gets the spawn position of the world
`VisualEffect`	`spawnVisual(VisualEffectType visual)` Creates a new visual effect
`void`	`tick()`
`Set<Tile>`	`tilesInternal()`
`long`	`time()` Gets the time in the world
`String`	`toString()`
`WeatherConditions`	`weather()` Obtains the weather controller for the world

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - tick
```
public void tick()
```
  - addChunkAt
```
protected void addChunkAt(ChunkLocation location,
                          Chunk chunk)
```
  - random
```
public GeneratorRandom random()
```
  - save
```
public void save()
```
  - addEntity
```
public Entity addEntity(Entity entity)
```
  - removeEntity
```
public void removeEntity(Entity entity)
```
  - name
```
public String name()
```
    Description copied from interface: World
    
    Gets the name of the world
    
    Specified by:
    
    name in interface World
    
    Returns:
    
    the name of the world
  - chunks
```
public Collection<Chunk> chunks()
```
    Description copied from interface: World
    
    Obtains the loaded chunks in the world
    
    Specified by:
    
    chunks in interface World
    
    Returns:
    
    the loaded chunks
  - loadedChunks
```
public Collection<TridentChunk> loadedChunks()
```
  - chunkHandler
```
public ChunkHandler chunkHandler()
```
  - chunkAt
```
public Chunk chunkAt(int x,
                     int z,
                     boolean generateIfNotFound)
```
    Description copied from interface: World
    
    Gets the chunk on the given x and z , and generates the chunk if it does not exist
    
    Specified by:
    
    chunkAt in interface World
    
    Returns:
    
    The chunk on the given position
  - chunkAt
```
public TridentChunk chunkAt(ChunkLocation location,
                            boolean generateIfNotFound)
```
    Description copied from interface: World
    
    Gets the chunk on the given position, and generates the chunk if it does not exist.
    
    Specified by:
    
    chunkAt in interface World
    
    Returns:
    
    The chunk on the given position
  - generateChunk
```
public Chunk generateChunk(int x,
                           int z)
```
    Description copied from interface: World
    
    Generates the chunk on the given position
    
    Specified by:
    
    generateChunk in interface World
    
    Returns:
    
    The generated chunk
  - generateChunk
```
public TridentChunk generateChunk(ChunkLocation location)
```
    Description copied from interface: World
    
    Generates the chunk on the given position
    
    Specified by:
    
    generateChunk in interface World
    
    Returns:
    
    The generated chunk
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - blockAt
```
public Block blockAt(Position location)
```
    Description copied from interface: World
    
    Gets the block on the given position
    
    Specified by:
    
    blockAt in interface World
    
    Returns:
    
    The block on the given position
  - loader
```
public WorldLoader loader()
```
    Description copied from interface: World
    
    Obtains the loading handler which created this object, passed in from the constructor
    
    Specified by:
    
    loader in interface World
    
    Returns:
    
    the world loader for this world
  - spawnPosition
```
public Position spawnPosition()
```
    Description copied from interface: World
    
    Gets the spawn position of the world
    
    Specified by:
    
    spawnPosition in interface World
    
    Returns:
    
    The spawn position in the world
  - weather
```
public WeatherConditions weather()
```
    Description copied from interface: World
    
    Obtains the weather controller for the world
    
    Specified by:
    
    weather in interface World
    
    Returns:
    
    the weather controller
  - settings
```
public WorldSettings settings()
```
    Description copied from interface: World
    
    Obtains the settings which modify the behavior of the world
    
    Specified by:
    
    settings in interface World
    
    Returns:
    
    the world settigs
  - border
```
public WorldBorder border()
```
    Description copied from interface: World
    
    Obtains the world border properties of this world
    
    Specified by:
    
    border in interface World
    
    Returns:
    
    the border properties
  - time
```
public long time()
```
    Description copied from interface: World
    
    Gets the time in the world
    
    Specified by:
    
    time in interface World
    
    Returns:
    
    The time in the world
  - spawn
```
public Entity spawn(EntityType type,
                    Position spawnPosition)
```
    Description copied from interface: World
    
    Spawns an entity in the world
    
    Specified by:
    
    spawn in interface World
    
    Parameters:
    
    type - the type of entity to spawn
    
    Returns:
    
    the entity spawn
  - entities
```
public Set<Entity> entities()
```
    Description copied from interface: World
    
    Get the entities currently in this world
    
    Specified by:
    
    entities in interface World
    
    Returns:
    
    the entities in the world
  - internalEntities
```
public Set<Entity> internalEntities()
```
  - tilesInternal
```
public Set<Tile> tilesInternal()
```
  - spawnParticle
```
public ParticleEffect spawnParticle(ParticleEffectType particle)
```
    Description copied from interface: World
    
    Creates a new particle effect
    
    Specified by:
    
    spawnParticle in interface World
    
    Parameters:
    
    particle - The particle to spawn
    
    Returns:
    
    A new instance of ParticleEffect
  - spawnVisual
```
public VisualEffect spawnVisual(VisualEffectType visual)
```
    Description copied from interface: World
    
    Creates a new visual effect
    
    Specified by:
    
    spawnVisual in interface World
    
    Parameters:
    
    visual - The visual to spawn
    
    Returns:
    
    A new instance of VisualEffect
  - playSound
```
public SoundEffect playSound(SoundEffectType sound)
```
    Description copied from interface: World
    
    Creates a new sound effect
    
    Specified by:
    
    playSound in interface World
    
    Parameters:
    
    sound - The sound to play
    
    Returns:
    
    A new instance of VisualEffect
  - lightning
```
public void lightning(Position position,
                      boolean b)
```
    Description copied from interface: World
    
    Strikes lightning at the given location.
    
    Specified by:
    
    lightning in interface World
    
    Parameters:
    
    position - the location that the lightning will hit
    
    b - determines if the lightning is just a effect or can cause damage
  - setTime
```
public void setTime(long l)
```
    Description copied from interface: World
    
    Sets the time of the world
    
    Specified by:
    
    setTime in interface World
    
    Parameters:
    
    l - the new time of the world
  - getEntities
```
public ArrayList<Entity> getEntities(Entity exclude,
                                     BoundingBox boundingBox,
                                     java.util.function.Predicate<? super Entity> predicate)
```
    Description copied from interface: World
    
    Find all entities that are colliding with the bounding box
    
    Specified by:
    
    getEntities in interface World
    
    Parameters:
    
    exclude - the entity to exclude from searching
    
    boundingBox - The bounding box to search in
    
    predicate - Predicate to filter results
    
    Returns:
    
    List of entities inside the bounding box
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TridentWorld

Method Summary

Methods inherited from class java.lang.Object

Method Detail

tick

addChunkAt

random

save

addEntity

removeEntity

name

chunks

loadedChunks

chunkHandler

chunkAt

chunkAt

generateChunk

generateChunk

equals

blockAt

loader

spawnPosition

weather

settings

border

time

spawn

entities

internalEntities

tilesInternal

spawnParticle

spawnVisual

playSound

lightning

setTime

getEntities

toString