org.spongepowered.api.world.extent

Interface Extent

All Superinterfaces:

BiomeVolume, BlockVolume, EntityUniverse, Identifiable, InteractableVolume, LocationBasePropertyHolder, LocationCompositeValueStore, MutableBiomeVolume, MutableBlockVolume, TileEntityVolume

All Known Subinterfaces:

Chunk, World

public interface Extent
extends EntityUniverse, TileEntityVolume, InteractableVolume, MutableBiomeVolume, LocationCompositeValueStore, Identifiable, LocationBasePropertyHolder

A mutable object containing blocks, tile entities, entities, and possibly other game objects.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.world.extent.EntityUniverse

EntityUniverse.EntityHit

Method Summary

Modifier and Type	Method and Description
ScheduledBlockUpdate	addScheduledUpdate(int x, int y, int z, int priority, int ticks) Adds a new ScheduledBlockUpdate to this block.
default ScheduledBlockUpdate	addScheduledUpdate(com.flowpowered.math.vector.Vector3i position, int priority, int ticks) Adds a new ScheduledBlockUpdate to this block.
ArchetypeVolume	createArchetypeVolume(com.flowpowered.math.vector.Vector3i min, com.flowpowered.math.vector.Vector3i max, com.flowpowered.math.vector.Vector3i origin) Creates a new archetype volume from the specified section of this extent.
BlockSnapshot	createSnapshot(int x, int y, int z) Gets a snapshot of this block at the current point in time.
default BlockSnapshot	createSnapshot(com.flowpowered.math.vector.Vector3i position) Gets a snapshot of this block at the current point in time.
MutableBiomeVolumeWorker<? extends Extent>	getBiomeWorker() Gets a new biome worker for this biome volume.
Optional<AABB>	getBlockSelectionBox(int x, int y, int z) Gets the bounding box used to select blocks, which appears as a black outline on a vanilla client.
default Optional<AABB>	getBlockSelectionBox(com.flowpowered.math.vector.Vector3i pos) Gets the bounding box used to select blocks, which appears as a black outline on a vanilla client.
MutableBlockVolumeWorker<? extends Extent>	getBlockWorker() Gets a new block worker for this block volume.
Optional<UUID>	getCreator(int x, int y, int z) Gets the UUID, if available, of the user who created the BlockSnapshot at passed block position.
default Optional<UUID>	getCreator(com.flowpowered.math.vector.Vector3i pos) Gets the UUID, if available, of the user who created the BlockSnapshot at passed block position.
Extent	getExtentView(com.flowpowered.math.vector.Vector3i newMin, com.flowpowered.math.vector.Vector3i newMax) Returns a new extent that is the same or smaller than the current extent.
default com.flowpowered.math.vector.Vector3i	getHighestPositionAt(com.flowpowered.math.vector.Vector3i position) Get the Location of the highest block that sunlight can reach in the given column.
int	getHighestYAt(int x, int z) Get the y value of the highest block that sunlight can reach in the given column.
default int	getHighestYAt(com.flowpowered.math.vector.Vector2i column) Get the y value of the highest block that sunlight can reach in the given column.
Set<AABB>	getIntersectingBlockCollisionBoxes(AABB box) Gets all the block collision boxes that intersect the bounding box, in no particular order.
default Set<AABB>	getIntersectingCollisionBoxes(Entity owner) Gets all the collision boxes that intersect the bounding box owned by the entity, in no particular order.
Set<AABB>	getIntersectingCollisionBoxes(Entity owner, AABB box) Gets all the collision boxes that intersect the bounding box owned by the entity, in no particular order.
default Location<? extends Extent>	getLocation(double x, double y, double z) Gets a location in this extent at the given position.
default Location<? extends Extent>	getLocation(int x, int y, int z) Gets a location in this extent at the given position.
Location<? extends Extent>	getLocation(com.flowpowered.math.vector.Vector3d position) Gets a location in this extent at the given position.
Location<? extends Extent>	getLocation(com.flowpowered.math.vector.Vector3i position) Gets a location in this extent at the given position.
Optional<UUID>	getNotifier(int x, int y, int z) Gets the UUID, if available, of the user who last notified the BlockSnapshot located at passed block coordinates.
default Optional<UUID>	getNotifier(com.flowpowered.math.vector.Vector3i pos) Gets the UUID, if available, of the user who last notified the BlockSnapshot located at passed block position.
int	getPrecipitationLevelAt(int x, int z) Returns the y level that precipitation ends falling in the given column.
default int	getPrecipitationLevelAt(com.flowpowered.math.vector.Vector2i column) Returns the y level that precipitation ends falling in the given column.
default com.flowpowered.math.vector.Vector3i	getPrecipitationLevelAt(com.flowpowered.math.vector.Vector3i position) Returns the position that precipitation ends falling in the column of the given position.
Collection<ScheduledBlockUpdate>	getScheduledUpdates(int x, int y, int z) Gets a list of ScheduledBlockUpdates on this block.
default Collection<ScheduledBlockUpdate>	getScheduledUpdates(com.flowpowered.math.vector.Vector3i position) Gets a list of ScheduledBlockUpdates on this block.
boolean	isLoaded() Gets whether or not this extent is currently loaded.
void	removeScheduledUpdate(int x, int y, int z, ScheduledBlockUpdate update) Removes a ScheduledBlockUpdate from this block.
default void	removeScheduledUpdate(com.flowpowered.math.vector.Vector3i position, ScheduledBlockUpdate update) Removes a ScheduledBlockUpdate from this block.
boolean	restoreSnapshot(BlockSnapshot snapshot, boolean force, BlockChangeFlag flag) Restores the given BlockSnapshot using the saved block position stored within the snapshot.
boolean	restoreSnapshot(int x, int y, int z, BlockSnapshot snapshot, boolean force, BlockChangeFlag flag) Restores the BlockSnapshot at the given position.
default boolean	restoreSnapshot(com.flowpowered.math.vector.Vector3i position, BlockSnapshot snapshot, boolean force, BlockChangeFlag flag) Restores the BlockSnapshot at the given position.
boolean	setBlock(int x, int y, int z, BlockState blockState, BlockChangeFlag flag) Sets the block at the given position in the world.
default boolean	setBlock(com.flowpowered.math.vector.Vector3i position, BlockState blockState, BlockChangeFlag flag) Sets the block at the given position in the world.
default boolean	setBlockType(int x, int y, int z, BlockType type, BlockChangeFlag flag) Sets the block at the given position in the world.
default boolean	setBlockType(com.flowpowered.math.vector.Vector3i position, BlockType type, BlockChangeFlag flag) Sets the block at the given position in the world.
void	setCreator(int x, int y, int z, UUID uuid) Sets the UUID of the user who created the BlockSnapshot located at passed block coordinates.
default void	setCreator(com.flowpowered.math.vector.Vector3i pos, UUID uuid) Sets the UUID of the user who created the BlockSnapshot located at passed block position.
void	setNotifier(int x, int y, int z, UUID uuid) Sets the UUID of the user who last notified the BlockSnapshot located at passed block coordinates.
default void	setNotifier(com.flowpowered.math.vector.Vector3i pos, UUID uuid) Sets the UUID of the user who last notified the BlockSnapshot located at passed block position.

Methods inherited from interface org.spongepowered.api.world.extent.EntityUniverse

createEntity, createEntity, createEntity, createEntity, createEntityNaturally, createEntityNaturally, getEntities, getEntities, getEntity, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getIntersectingEntities, getNearbyEntities, restoreSnapshot, spawnEntities, spawnEntity

Methods inherited from interface org.spongepowered.api.world.extent.TileEntityVolume

getTileEntities, getTileEntities, getTileEntity, getTileEntity

Methods inherited from interface org.spongepowered.api.world.extent.InteractableVolume

digBlock, digBlock, digBlockWith, digBlockWith, getBlockDigTimeWith, getBlockDigTimeWith, hitBlock, hitBlock, interactBlock, interactBlock, interactBlockWith, interactBlockWith, placeBlock, placeBlock

Methods inherited from interface org.spongepowered.api.world.extent.MutableBlockVolume

getBlockView, getBlockView, getRelativeBlockView, setBlock, setBlock, setBlockType, setBlockType

Methods inherited from interface org.spongepowered.api.world.extent.BlockVolume

containsBlock, containsBlock, getBlock, getBlock, getBlockCopy, getBlockCopy, getBlockMax, getBlockMin, getBlockSize, getBlockType, getBlockType, getImmutableBlockCopy, getUnmodifiableBlockView

Methods inherited from interface org.spongepowered.api.world.extent.MutableBiomeVolume

getBiomeView, getBiomeView, getRelativeBiomeView, setBiome, setBiome

Methods inherited from interface org.spongepowered.api.world.extent.BiomeVolume

containsBiome, containsBiome, getBiome, getBiome, getBiomeCopy, getBiomeCopy, getBiomeMax, getBiomeMin, getBiomeSize, getImmutableBiomeCopy, getUnmodifiableBiomeView

Methods inherited from interface org.spongepowered.api.world.extent.LocationCompositeValueStore

copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, copyFrom, get, get, get, get, getKeys, getKeys, getManipulators, getManipulators, getOrCreate, getOrCreate, getOrElse, getOrElse, getOrNull, getOrNull, getValue, getValue, getValues, getValues, offer, offer, offer, offer, offer, offer, offer, offer, offer, offer, offer, remove, remove, remove, remove, setRawData, setRawData, supports, supports, supports, supports, supports, supports, supports, supports, transform, transform, undo, undo, validateRawData, validateRawData

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

Methods inherited from interface org.spongepowered.api.data.property.LocationBasePropertyHolder

getFacesWithProperty, getFacesWithProperty, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty

Method Detail

getLocation

Location<? extends Extent> getLocation(com.flowpowered.math.vector.Vector3i position)

Gets a location in this extent at the given position. Essentially, this is a 3D pointer in the extent.

Parameters:

position - The position

Returns:

The location in this extent

getLocation

default Location<? extends Extent> getLocation(int x,
                                               int y,
                                               int z)

Gets a location in this extent at the given position. Essentially, this is a 3D pointer in the extent.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The location in this extent

getLocation

Location<? extends Extent> getLocation(com.flowpowered.math.vector.Vector3d position)

Gets a location in this extent at the given position. Essentially, this is a 3D pointer in the extent. This method supports sub-block positions. Block-related methods use flooring to get integer coordinates.

Parameters:

position - The position

Returns:

The location in this extent

getLocation

default Location<? extends Extent> getLocation(double x,
                                               double y,
                                               double z)

Gets a location in this extent at the given position. Essentially, this is a 3D pointer in the extent. This method supports sub-block positions. Block-related methods use flooring to get integer coordinates.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

The location in this extent

getHighestYAt

int getHighestYAt(int x,
                  int z)

Get the y value of the highest block that sunlight can reach in the given column.

This method ignores all transparent blocks, providing the highest opaque block.

Parameters:

x - The x column value

z - The z column value

Returns:

The y value of the highest opaque block

getHighestYAt

default int getHighestYAt(com.flowpowered.math.vector.Vector2i column)

Get the y value of the highest block that sunlight can reach in the given column.

This method ignores all transparent blocks, providing the highest opaque block.

Parameters:

column - The column value

Returns:

The y value of the highest opaque block

getHighestPositionAt

default com.flowpowered.math.vector.Vector3i getHighestPositionAt(com.flowpowered.math.vector.Vector3i position)

Get the Location of the highest block that sunlight can reach in the given column.

This method ignores all transparent blocks, providing the highest opaque block.

Parameters:

position - The column position

Returns:

The highest opaque position

getPrecipitationLevelAt

int getPrecipitationLevelAt(int x,
                            int z)

Returns the y level that precipitation ends falling in the given column.

A value is still returned for columns in biomes which do not receive precipitation.

Parameters:

x - The x column value

z - The y column value

Returns:

The y level that precipitation ends

getPrecipitationLevelAt

default int getPrecipitationLevelAt(com.flowpowered.math.vector.Vector2i column)

Returns the y level that precipitation ends falling in the given column.

A value is still returned for columns in biomes which do not receive precipitation.

Parameters:

column - The column value

Returns:

The y level that precipitation ends

getPrecipitationLevelAt

default com.flowpowered.math.vector.Vector3i getPrecipitationLevelAt(com.flowpowered.math.vector.Vector3i position)

Returns the position that precipitation ends falling in the column of the given position.

A position is still returned for positions in biomes which do not receive precipitation.

Parameters:

position - The position value

Returns:

The position that precipitation ends

setBlock

default boolean setBlock(com.flowpowered.math.vector.Vector3i position,
                         BlockState blockState,
                         BlockChangeFlag flag)

Sets the block at the given position in the world.

Parameters:

position - The position

blockState - The block

flag - The various change flags controlling some interactions

Returns:

Whether the block change was successful

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the volume

setBlock

boolean setBlock(int x,
                 int y,
                 int z,
                 BlockState blockState,
                 BlockChangeFlag flag)

Sets the block at the given position in the world.

Parameters:

x - The X position

y - The Y position

z - The Z position

blockState - The block

flag - The various change flags controlling some interactions

Returns:

Whether the block change was successful

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the volume

setBlockType

default boolean setBlockType(com.flowpowered.math.vector.Vector3i position,
                             BlockType type,
                             BlockChangeFlag flag)

Sets the block at the given position in the world.

Parameters:

position - The position

type - The block type

flag - The various change flags controlling some interactions

Returns:

Whether the block change was successful

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the volume

setBlockType

default boolean setBlockType(int x,
                             int y,
                             int z,
                             BlockType type,
                             BlockChangeFlag flag)

Sets the block at the given position in the world.

Parameters:

x - The X position

y - The Y position

z - The Z position

type - The block

flag - The various change flags controlling some interactions

Returns:

Whether the block change was successful

Throws:

PositionOutOfBoundsException - If the position is outside of the bounds of the volume

createSnapshot

default BlockSnapshot createSnapshot(com.flowpowered.math.vector.Vector3i position)

Gets a snapshot of this block at the current point in time.

A snapshot is disconnected from the Extent that it was taken from so changes to the original block do not affect the snapshot.

Parameters:

position - The position of the block

Returns:

A snapshot

createSnapshot

BlockSnapshot createSnapshot(int x,
                             int y,
                             int z)

Gets a snapshot of this block at the current point in time.

A snapshot is disconnected from the Extent that it was taken from so changes to the original block do not affect the snapshot.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

A snapshot

restoreSnapshot

boolean restoreSnapshot(BlockSnapshot snapshot,
                        boolean force,
                        BlockChangeFlag flag)

Restores the given BlockSnapshot using the saved block position stored within the snapshot.

If forced, the state of the block will change its BlockType to match that of the snapshot then set the state. However, if force is set to false and the BlockTypes does not match, false will be returned. If notifyNeighbors is true, neighboring blocks will be notified of changes at the restored block location triggering physic updates.

Parameters:

snapshot - The snapshot

force - If true, forces block state to be set even if the BlockType does not match the snapshot one.

flag - The various change flags controlling some interactions

Returns:

true if the restore was successful, false otherwise

restoreSnapshot

default boolean restoreSnapshot(com.flowpowered.math.vector.Vector3i position,
                                BlockSnapshot snapshot,
                                boolean force,
                                BlockChangeFlag flag)

Restores the BlockSnapshot at the given position.

If forced, the state of the block will change its BlockType to match that of the snapshot then set the state. However, if force is set to false and the BlockTypes does not match, false will be returned. If notifyNeighbors is true, neighboring blocks will be notified of changes at the restored block location triggering physic updates.

Parameters:

position - The position of the block

snapshot - The snapshot

force - If true, forces block state to be set even if the BlockType does not match the snapshot one.

flag - The various change flags controlling some interactions

Returns:

true if the restore was successful, false otherwise

restoreSnapshot

boolean restoreSnapshot(int x,
                        int y,
                        int z,
                        BlockSnapshot snapshot,
                        boolean force,
                        BlockChangeFlag flag)

Restores the BlockSnapshot at the given position.

If forced, the state of the block will change its BlockType to match that of the snapshot then set the state. However, if force is set to false and the BlockTypes does not match, false will be returned. If notifyNeighbors is true, neighboring blocks will be notified of changes at the restored block location triggering physic updates.

Parameters:

x - The X position

y - The Y position

z - The Z position

snapshot - The snapshot

force - If true, forces block state to be set even if the BlockType does not match the snapshot one.

flag - The various change flags controlling some interactions

Returns:

true if the restore was successful, false otherwise

getScheduledUpdates

default Collection<ScheduledBlockUpdate> getScheduledUpdates(com.flowpowered.math.vector.Vector3i position)

Gets a list of ScheduledBlockUpdates on this block.

Parameters:

position - The position of the block

Returns:

A list of ScheduledBlockUpdates on this block

getScheduledUpdates

Collection<ScheduledBlockUpdate> getScheduledUpdates(int x,
                                                     int y,
                                                     int z)

Gets a list of ScheduledBlockUpdates on this block.

Parameters:

x - The X position

y - The Y position

z - The Z position

Returns:

A list of ScheduledBlockUpdates on this block

addScheduledUpdate

default ScheduledBlockUpdate addScheduledUpdate(com.flowpowered.math.vector.Vector3i position,
                                                int priority,
                                                int ticks)

Adds a new ScheduledBlockUpdate to this block.

Parameters:

position - The position of the block

priority - The priority of the scheduled update

ticks - The ticks until the scheduled update should be processed

Returns:

The newly created scheduled update

addScheduledUpdate

ScheduledBlockUpdate addScheduledUpdate(int x,
                                        int y,
                                        int z,
                                        int priority,
                                        int ticks)

Adds a new ScheduledBlockUpdate to this block.

Parameters:

x - The X position

y - The Y position

z - The Z position

priority - The priority of the scheduled update

ticks - The ticks until the scheduled update should be processed

Returns:

The newly created scheduled update

removeScheduledUpdate

default void removeScheduledUpdate(com.flowpowered.math.vector.Vector3i position,
                                   ScheduledBlockUpdate update)

Removes a ScheduledBlockUpdate from this block.

Parameters:

position - The position of the block

update - The ScheduledBlockUpdate to remove

removeScheduledUpdate

void removeScheduledUpdate(int x,
                           int y,
                           int z,
                           ScheduledBlockUpdate update)

Removes a ScheduledBlockUpdate from this block.

Parameters:

x - The X position

y - The Y position

z - The Z position

update - The ScheduledBlockUpdate to remove

isLoaded

boolean isLoaded()

Gets whether or not this extent is currently loaded.

Returns:

Whether or not this extent is loaded

getExtentView

Extent getExtentView(com.flowpowered.math.vector.Vector3i newMin,
                     com.flowpowered.math.vector.Vector3i newMax)

Returns a new extent that is the same or smaller than the current extent. This does not copy the data, it only provides a new view of the extent.

Parameters:

newMin - The new minimum coordinates in this extent

newMax - The new maximum coordinates in this extent

Returns:

The new extent with the new bounds

Throws:

PositionOutOfBoundsException - If the new minimum and maximum are outside the current extent

getBiomeWorker

MutableBiomeVolumeWorker<? extends Extent> getBiomeWorker()

Description copied from interface: BiomeVolume

Gets a new biome worker for this biome volume.

Specified by:

getBiomeWorker in interface BiomeVolume

Specified by:

getBiomeWorker in interface MutableBiomeVolume

Returns:

The biome worker

getBlockWorker

MutableBlockVolumeWorker<? extends Extent> getBlockWorker()

Description copied from interface: BlockVolume

Gets a new block worker for this block volume.

Specified by:

getBlockWorker in interface BlockVolume

Specified by:

getBlockWorker in interface InteractableVolume

Specified by:

getBlockWorker in interface MutableBlockVolume

Specified by:

getBlockWorker in interface TileEntityVolume

Returns:

The block worker

getCreator

default Optional<UUID> getCreator(com.flowpowered.math.vector.Vector3i pos)

Gets the UUID, if available, of the user who created the BlockSnapshot at passed block position.

Parameters:

pos - The position to be checked

Returns:

The UUID if one exists

getCreator

Optional<UUID> getCreator(int x,
                          int y,
                          int z)

Gets the UUID, if available, of the user who created the BlockSnapshot at passed block position.

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

Returns:

The UUID if one exists

getNotifier

default Optional<UUID> getNotifier(com.flowpowered.math.vector.Vector3i pos)

Gets the UUID, if available, of the user who last notified the BlockSnapshot located at passed block position.

Parameters:

pos - The position to be checked

Returns:

The UUID if one exists

getNotifier

Optional<UUID> getNotifier(int x,
                           int y,
                           int z)

Gets the UUID, if available, of the user who last notified the BlockSnapshot located at passed block coordinates.

Parameters:

x - The x coordinate

y - The y coordinate

z - The z coordinate

Returns:

The UUID if available

setCreator

default void setCreator(com.flowpowered.math.vector.Vector3i pos,
                        @Nullable
                        UUID uuid)

Sets the UUID of the user who created the BlockSnapshot located at passed block position.

Parameters:

pos - The block position where the user data should be applied

uuid - The UUID to set as creator

setCreator

void setCreator(int x,
                int y,
                int z,
                @Nullable
                UUID uuid)

Sets the UUID of the user who created the BlockSnapshot located at passed block coordinates.

Parameters:

x - The x coordinate where the user data should be applied

y - The y coordinate where the user data should be applied

z - The z coordinate where the user data should be applied

uuid - The UUID to set as creator

setNotifier

default void setNotifier(com.flowpowered.math.vector.Vector3i pos,
                         @Nullable
                         UUID uuid)

Sets the UUID of the user who last notified the BlockSnapshot located at passed block position.

Parameters:

pos - The block position where the user data should be applied

uuid - The UUID to set as notifier

setNotifier

void setNotifier(int x,
                 int y,
                 int z,
                 @Nullable
                 UUID uuid)

Sets the UUID of the user who last notified the BlockSnapshot located at passed block coordinates.

Parameters:

x - The x coordinate where the user data should be applied

y - The y coordinate where the user data should be applied

z - The z coordinate where the user data should be applied

uuid - The UUID to set as notifier

getBlockSelectionBox

default Optional<AABB> getBlockSelectionBox(com.flowpowered.math.vector.Vector3i pos)

Gets the bounding box used to select blocks, which appears as a black outline on a vanilla client.

Parameters:

pos - The position of the block from which to get the selection box

Returns:

The selection box

getBlockSelectionBox

Optional<AABB> getBlockSelectionBox(int x,
                                    int y,
                                    int z)

Gets the bounding box used to select blocks, which appears as a black outline on a vanilla client.

Parameters:

x - The x coord of the block from which to get the selection box

y - The y coord of the block from which to get the selection box

z - The z coord of the block from which to get the selection box

Returns:

The selection box

getIntersectingBlockCollisionBoxes

Set<AABB> getIntersectingBlockCollisionBoxes(AABB box)

Gets all the block collision boxes that intersect the bounding box, in no particular order. There may be more than one box per block.

Parameters:

box - The intersection box

Returns:

All the intersecting block collision boxes

getIntersectingCollisionBoxes

default Set<AABB> getIntersectingCollisionBoxes(Entity owner)

Gets all the collision boxes that intersect the bounding box owned by the entity, in no particular order. There may be more than one box per block. This also includes entities. Will return an empty set if the owner does not have a bounding box.

Parameters:

owner - The entity that owns the bounding box

Returns:

All the intersecting collision boxes

getIntersectingCollisionBoxes

Set<AABB> getIntersectingCollisionBoxes(Entity owner,
                                        AABB box)

Gets all the collision boxes that intersect the bounding box owned by the entity, in no particular order. There may be more than one box per block. This also includes entities.

Parameters:

owner - The entity that owns the bounding box

box - The intersection box

Returns:

All the intersecting collision boxes

createArchetypeVolume

ArchetypeVolume createArchetypeVolume(com.flowpowered.math.vector.Vector3i min,
                                      com.flowpowered.math.vector.Vector3i max,
                                      com.flowpowered.math.vector.Vector3i origin)

Creates a new archetype volume from the specified section of this extent. The archetype's volume will be shifted such that the position given in the origin will be the origin of the volume.

Parameters:

min - The minimum point of the volume to copy

max - The maximum point of the volume to copy

origin - The eventual origin on the new archetype volume

Returns:

The archetype volume