diff options
author | Julian Laubstein <julianlaubstein@yahoo.de> | 2016-02-06 11:37:34 +0100 |
---|---|---|
committer | Julian Laubstein <julianlaubstein@yahoo.de> | 2016-02-06 11:37:34 +0100 |
commit | 6fdd7194c81be7234a126bdc3b48f0291fce3567 (patch) | |
tree | 7d5ac74b7385ce4ebf77588d80549c884c2b993c /src/Generating/ChunkGenerator.h | |
parent | Merge pull request #2958 from LogicParrot/fence (diff) | |
parent | Bulk clearing of whitespace (diff) | |
download | cuberite-6fdd7194c81be7234a126bdc3b48f0291fce3567.tar cuberite-6fdd7194c81be7234a126bdc3b48f0291fce3567.tar.gz cuberite-6fdd7194c81be7234a126bdc3b48f0291fce3567.tar.bz2 cuberite-6fdd7194c81be7234a126bdc3b48f0291fce3567.tar.lz cuberite-6fdd7194c81be7234a126bdc3b48f0291fce3567.tar.xz cuberite-6fdd7194c81be7234a126bdc3b48f0291fce3567.tar.zst cuberite-6fdd7194c81be7234a126bdc3b48f0291fce3567.zip |
Diffstat (limited to 'src/Generating/ChunkGenerator.h')
-rw-r--r-- | src/Generating/ChunkGenerator.h | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/src/Generating/ChunkGenerator.h b/src/Generating/ChunkGenerator.h index b7968356f..5c778fda4 100644 --- a/src/Generating/ChunkGenerator.h +++ b/src/Generating/ChunkGenerator.h @@ -37,7 +37,7 @@ class cChunkGenerator : cIsThread { typedef cIsThread super; - + public: /** The interface that a class has to implement to become a generator */ class cGenerator @@ -48,7 +48,7 @@ public: /** Called to initialize the generator on server startup. */ virtual void Initialize(cIniFile & a_IniFile); - + /** Generates the biomes for the specified chunk (directly, not in a separate thread). Used by the world loader if biomes failed loading. */ virtual void GenerateBiomes(int a_ChunkX, int a_ChunkZ, cChunkDef::BiomeMap & a_BiomeMap) = 0; @@ -57,47 +57,47 @@ public: /** Called in a separate thread to do the actual chunk generation. Generator should generate into a_ChunkDesc. */ virtual void DoGenerate(int a_ChunkX, int a_ChunkZ, cChunkDesc & a_ChunkDesc) = 0; - + protected: cChunkGenerator & m_ChunkGenerator; } ; - - + + /** The interface through which the plugins are called for their OnChunkGenerating / OnChunkGenerated hooks. */ class cPluginInterface { public: // Force a virtual destructor virtual ~cPluginInterface() {} - + /** Called when the chunk is about to be generated. The generator may be partly or fully overriden by the implementation. */ virtual void CallHookChunkGenerating(cChunkDesc & a_ChunkDesc) = 0; - + /** Called after the chunk is generated, before it is handed to the chunk sink. a_ChunkDesc contains the generated chunk data. Implementation may modify this data. */ virtual void CallHookChunkGenerated(cChunkDesc & a_ChunkDesc) = 0; } ; - - + + /** The interface through which the generated chunks are handed to the cWorld or whoever created us. */ class cChunkSink { public: // Force a virtual destructor virtual ~cChunkSink() {} - + /** Called after the chunk has been generated The interface may store the chunk, send it over network, whatever. The chunk is not expected to be modified, but the generator will survive if the implementation changes the data within. All changes are ignored, though. */ virtual void OnChunkGenerated(cChunkDesc & a_ChunkDesc) = 0; - + /** Called just before the chunk generation is started, to verify that it hasn't been generated in the meantime. If this callback returns true, the chunk is not generated. */ virtual bool IsChunkValid(int a_ChunkX, int a_ChunkZ) = 0; - + /** Called when the generator is overloaded to skip chunks that are no longer needed. If this callback returns false, the chunk is not generated. */ virtual bool HasChunkAnyClients(int a_ChunkX, int a_ChunkZ) = 0; @@ -106,7 +106,7 @@ public: Currently used only in Debug-mode asserts. */ virtual bool IsChunkQueued(int a_ChunkX, int a_ChunkZ) = 0; } ; - + cChunkGenerator (void); ~cChunkGenerator(); @@ -120,22 +120,22 @@ public: It is legal to set the callback to nullptr, no callback is called then. If the generator becomes overloaded and skips this chunk, the callback is still called. */ void QueueGenerateChunk(int a_ChunkX, int a_ChunkZ, bool a_ForceGenerate, cChunkCoordCallback * a_Callback = nullptr); - + /** Generates the biomes for the specified chunk (directly, not in a separate thread). Used by the world loader if biomes failed loading. */ void GenerateBiomes(int a_ChunkX, int a_ChunkZ, cChunkDef::BiomeMap & a_BiomeMap); - + void WaitForQueueEmpty(void); - + int GetQueueLength(void); - + int GetSeed(void) const { return m_Seed; } - + /** Returns the biome at the specified coords. Used by ChunkMap if an invalid chunk is queried for biome */ EMCSBiome GetBiomeAt(int a_BlockX, int a_BlockZ); /** Reads a block type from the ini file; returns the blocktype on success, emits a warning and returns a_Default's representation on failure. */ static BLOCKTYPE GetIniBlock(cIniFile & a_IniFile, const AString & a_SectionName, const AString & a_ValueName, const AString & a_Default); - + private: struct cQueueItem @@ -167,16 +167,16 @@ private: /** Set when an item is removed from the queue. */ cEvent m_evtRemoved; - + /** The actual generator engine used to generate chunks. */ cGenerator * m_Generator; - + /** The plugin interface that may modify the generated chunks */ cPluginInterface * m_PluginInterface; - + /** The destination where the generated chunks are sent */ cChunkSink * m_ChunkSink; - + // cIsThread override: virtual void Execute(void) override; |