001/* 002 * Trident - A Multithreaded Server Alternative 003 * Copyright 2014 The TridentSDK Team 004 * 005 * Licensed under the Apache License, Version 2.0 (the "License"); 006 * you may not use this file except in compliance with the License. 007 * You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017 018package net.tridentsdk.world.gen; 019 020import net.tridentsdk.world.ChunkLocation; 021 022import java.util.concurrent.atomic.AtomicReferenceArray; 023 024/** 025 * The base class for implementing world generation extensions 026 * 027 * @author The TridentSDK Team 028 * @since 0.3-alpha-DP 029 */ 030public abstract class ChunkGenerator { 031 protected final long seed; 032 033 public ChunkGenerator(long seed) { 034 this.seed = seed; 035 } 036 037 /** 038 * Obtains the chunk generation seed 039 * 040 * @return the seed 041 */ 042 public long seed() { 043 return this.seed; 044 } 045 046 /** 047 * Populates the block ids for a chunk 048 * 049 * <p>The first array index is the section number, the 050 * second index is the position in that section, i.e. 051 * x << 8 + y << 4 + z</p> 052 * 053 * <p>Should only be invoked by TridentChunk</p> 054 * 055 * @param position the position of the chunk to be generated 056 * @param heights the array of max heights 057 * @return the data array to fill the chunk with 058 */ 059 public abstract char[][] generateBlocks(ChunkLocation position, AtomicReferenceArray<Integer> heights); 060 061 /** 062 * Populates block data for a chunk 063 * 064 * @param position the position of the chunk to be generated 065 * @return the data to apply to each block 066 */ 067 public abstract byte[][] generateData(ChunkLocation position); 068}