summaryrefslogtreecommitdiffstats
path: root/src/Simulator/FireSimulator.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/Simulator/FireSimulator.h19
1 files changed, 9 insertions, 10 deletions
diff --git a/src/Simulator/FireSimulator.h b/src/Simulator/FireSimulator.h
index a40e29565..a59c66de5 100644
--- a/src/Simulator/FireSimulator.h
+++ b/src/Simulator/FireSimulator.h
@@ -31,35 +31,34 @@ public:
static bool DoesBurnForever(BLOCKTYPE a_BlockType);
protected:
- /// Time (in msec) that a fire block takes to burn with a fuel block into the next step
+ /** Time (in msec) that a fire block takes to burn with a fuel block into the next step */
unsigned m_BurnStepTimeFuel;
- /// Time (in msec) that a fire block takes to burn without a fuel block into the next step
+ /** Time (in msec) that a fire block takes to burn without a fuel block into the next step */
unsigned m_BurnStepTimeNonfuel;
- /// Chance [0..100000] of an adjacent fuel to catch fire on each tick
+ /** Chance [0..100000] of an adjacent fuel to catch fire on each tick */
int m_Flammability;
- /// Chance [0..100000] of a fuel burning out being replaced by a new fire block instead of an air block
+ /** Chance [0..100000] of a fuel burning out being replaced by a new fire block instead of an air block */
int m_ReplaceFuelChance;
virtual void AddBlock(int a_BlockX, int a_BlockY, int a_BlockZ, cChunk * a_Chunk) override;
- /// Returns the time [msec] after which the specified fire block is stepped again; based on surrounding fuels
+ /** Returns the time [msec] after which the specified fire block is stepped again; based on surrounding fuels */
int GetBurnStepTime(cChunk * a_Chunk, int a_RelX, int a_RelY, int a_RelZ);
- /// Tries to spread fire to a neighborhood of the specified block
+ /** Tries to spread fire to a neighborhood of the specified block */
void TrySpreadFire(cChunk * a_Chunk, int a_RelX, int a_RelY, int a_RelZ);
- /// Removes all burnable blocks neighboring the specified block
+ /** Removes all burnable blocks neighboring the specified block */
void RemoveFuelNeighbors(cChunk * a_Chunk, int a_RelX, int a_RelY, int a_RelZ);
/** Returns true if a fire can be started in the specified block,
that is, it is an air block and has fuel next to it.
Note that a_NearChunk may be a chunk neighbor to the block specified!
- The coords are relative to a_NearChunk but not necessarily in it.
- */
+ The coords are relative to a_NearChunk but not necessarily in it. */
bool CanStartFireInBlock(cChunk * a_NearChunk, int a_RelX, int a_RelY, int a_RelZ);
} ;
@@ -67,7 +66,7 @@ protected:
-/// Stores individual fire blocks in the chunk; the int data is used as the time [msec] the fire takes to step to another stage (blockmeta++)
+/** Stores individual fire blocks in the chunk; the int data is used as the time [msec] the fire takes to step to another stage (blockmeta++) */
typedef cCoordWithIntList cFireSimulatorChunkData;