Skip to content

Commit

Permalink
Added missing checks for Initialize function and updated APIDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Seadragon91 committed May 8, 2017
1 parent 41bfb22 commit 5580d55
Show file tree
Hide file tree
Showing 7 changed files with 76 additions and 18 deletions.
12 changes: 6 additions & 6 deletions Server/Plugins/APIDump/Classes/World.lua
Original file line number Diff line number Diff line change
Expand Up @@ -2910,7 +2910,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
Type = "number",
},
},
Notes = "Spawns a boat at the specific coordinates. Returns the entity ID of the new boat, or {{cEntity#NO_ID|cEntity.NO_ID}} if no boat was created.",
Notes = "Spawns a boat at the specific coordinates. Returns the EntityID of the new boat, or {{cEntity#INVALID_ID|cEntity#INVALID_ID}} if no boat was created.",
},
SpawnExperienceOrb =
{
Expand Down Expand Up @@ -2940,7 +2940,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
Type = "number",
},
},
Notes = "Spawns an {{cExpOrb|experience orb}} at the specified coords, with the given reward",
Notes = "Spawns an {{cExpOrb|experience orb}} at the specified coords, with the given reward. Returns the EntityID of the new experience orb, or {{cEntity#INVALID_ID|cEntity#INVALID_ID}} if no experience orb was created.",
},
SpawnFallingBlock =
{
Expand Down Expand Up @@ -2974,7 +2974,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
Type = "number",
},
},
Notes = "Spawns a {{cFallingBlock|Falling Block}} entity at the specified coords with the given block type/meta",
Notes = "Spawns a {{cFallingBlock|Falling Block}} entity at the specified coords with the given block type/meta. Returns the EntityID of the new falling block, or {{cEntity#INVALID_ID|cEntity#INVALID_ID}} if no falling block was created.",
},
SpawnItemPickups =
{
Expand Down Expand Up @@ -3088,7 +3088,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
Type = "number",
},
},
Notes = "Spawns a minecart at the specific coordinates. MinecartType is the item type of the minecart. If the minecart is an empty minecart then the given Item (default: empty) is the block to be displayed inside the minecart, and BlockHeight (default: 1) is the relative distance of the block from the minecart. Returns the entity ID of the new minecart, or {{cEntity#NO_ID|cEntity.NO_ID}} if no minecart was created.",
Notes = "Spawns a minecart at the specific coordinates. MinecartType is the item type of the minecart. If the minecart is an empty minecart then the given Item (default: empty) is the block to be displayed inside the minecart, and BlockHeight (default: 1) is the relative distance of the block from the minecart. Returns the EntityID of the new minecart, or {{cEntity#INVALID_ID|cEntity#INVALID_ID}} if no minecart was created.",
},
SpawnMob =
{
Expand Down Expand Up @@ -3123,7 +3123,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
Type = "number",
},
},
Notes = "Spawns the specified type of mob at the specified coords. If the Baby parameter is true, the mob will be a baby. Returns the EntityID of the creates entity, or -1 on failure. ",
Notes = "Spawns the specified type of mob at the specified coords. If the Baby parameter is true, the mob will be a baby. Returns the EntityID of the created entity, or {{cEntity#INVALID_ID|cEntity#INVALID_ID}} on failure.",
},
SpawnPrimedTNT =
{
Expand Down Expand Up @@ -3157,7 +3157,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
Type = "number",
},
},
Notes = "Spawns a {{cTNTEntity|primed TNT entity}} at the specified coords, with the given fuse ticks. The entity gets a random speed multiplied by the InitialVelocityCoeff, 1 being the default value.",
Notes = "Spawns a {{cTNTEntity|primed TNT entity}} at the specified coords, with the given fuse ticks. The entity gets a random speed multiplied by the InitialVelocityCoeff, 1 being the default value. Returns the EntityID of the new spawned primed tnt, or {{cEntity#INVALID_ID|cEntity#INVALID_ID}} if no primed tnt was created.",
},
TryGetHeight =
{
Expand Down
7 changes: 6 additions & 1 deletion src/Items/ItemBoat.h
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,12 @@ class cItemBoatHandler :

// Spawn block at water level
cBoat * Boat = new cBoat(x + 0.5, y + 0.5, z + 0.5);
Boat->Initialize(*a_World);
if (!Boat->Initialize(*a_World))
{
delete Boat;
Boat = nullptr;
return false;
}

// Remove boat from players hand
if (!a_Player->IsGameModeCreative())
Expand Down
7 changes: 6 additions & 1 deletion src/Items/ItemFishingRod.h
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,12 @@ class cItemFishingRodHandler :
else
{
cFloater * Floater = new cFloater(a_Player->GetPosX(), a_Player->GetStance(), a_Player->GetPosZ(), a_Player->GetLookVector() * 15, a_Player->GetUniqueID(), static_cast<int>(100 + static_cast<unsigned int>(a_World->GetTickRandomNumber(800)) - (a_Player->GetEquippedItem().m_Enchantments.GetLevel(cEnchantments::enchLure) * 100)));
Floater->Initialize(*a_World);
if (!Floater->Initialize(*a_World))
{
delete Floater;
Floater = nullptr;
return false;
}
a_Player->SetIsFishing(true, Floater->GetUniqueID());
}
return true;
Expand Down
7 changes: 6 additions & 1 deletion src/Items/ItemMinecart.h
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,12 @@ class cItemMinecartHandler :
return false;
}
} // switch (m_ItemType)
Minecart->Initialize(*a_World);
if (!Minecart->Initialize(*a_World))
{
delete Minecart;
Minecart = nullptr;
return false;
}

if (!a_Player->IsGameModeCreative())
{
Expand Down
7 changes: 6 additions & 1 deletion src/Items/ItemPainting.h
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,12 @@ class cItemPaintingHandler :
};

cPainting * Painting = new cPainting(gPaintingTitlesList[a_World->GetTickRandomNumber(ARRAYCOUNT(gPaintingTitlesList) - 1)].Title, a_BlockFace, a_BlockX, a_BlockY, a_BlockZ);
Painting->Initialize(*a_World);
if (!Painting->Initialize(*a_World))
{
delete Painting;
Painting = nullptr;
return false;
}

if (!a_Player->IsGameModeCreative())
{
Expand Down
7 changes: 6 additions & 1 deletion src/Simulator/SandSimulator.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,12 @@ void cSandSimulator::SimulateChunk(std::chrono::milliseconds a_Dt, int a_ChunkX,
);
*/
cFallingBlock * FallingBlock = new cFallingBlock(Pos, BlockType, a_Chunk->GetMeta(itr->x, itr->y, itr->z));
FallingBlock->Initialize(m_World);
if (!FallingBlock->Initialize(m_World))
{
delete FallingBlock;
FallingBlock = nullptr;
continue;
}
a_Chunk->SetBlock(itr->x, itr->y, itr->z, E_BLOCK_AIR, 0);
}
}
Expand Down
47 changes: 40 additions & 7 deletions src/World.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2183,7 +2183,11 @@ void cWorld::SpawnItemPickups(const cItems & a_Pickups, double a_BlockX, double
a_BlockX, a_BlockY, a_BlockZ,
*itr, IsPlayerCreated, SpeedX, SpeedY, SpeedZ
);
Pickup->Initialize(*this);
if (!Pickup->Initialize(*this))
{
delete Pickup;
Pickup = nullptr;
}
}
}

Expand All @@ -2204,7 +2208,11 @@ void cWorld::SpawnItemPickups(const cItems & a_Pickups, double a_BlockX, double
a_BlockX, a_BlockY, a_BlockZ,
*itr, IsPlayerCreated, static_cast<float>(a_SpeedX), static_cast<float>(a_SpeedY), static_cast<float>(a_SpeedZ)
);
Pickup->Initialize(*this);
if (!Pickup->Initialize(*this))
{
delete Pickup;
Pickup = nullptr;
}
}
}

Expand All @@ -2215,7 +2223,12 @@ void cWorld::SpawnItemPickups(const cItems & a_Pickups, double a_BlockX, double
UInt32 cWorld::SpawnFallingBlock(int a_X, int a_Y, int a_Z, BLOCKTYPE BlockType, NIBBLETYPE BlockMeta)
{
cFallingBlock * FallingBlock = new cFallingBlock(Vector3i(a_X, a_Y, a_Z), BlockType, BlockMeta);
FallingBlock->Initialize(*this);
if (!FallingBlock->Initialize(*this))
{
delete FallingBlock;
FallingBlock = nullptr;
return cEntity::INVALID_ID;
}
return FallingBlock->GetUniqueID();
}

Expand All @@ -2232,7 +2245,12 @@ UInt32 cWorld::SpawnExperienceOrb(double a_X, double a_Y, double a_Z, int a_Rewa
}

cExpOrb * ExpOrb = new cExpOrb(a_X, a_Y, a_Z, a_Reward);
ExpOrb->Initialize(*this);
if (!ExpOrb->Initialize(*this))
{
delete ExpOrb;
ExpOrb = nullptr;
return cEntity::INVALID_ID;
}
return ExpOrb->GetUniqueID();
}

Expand All @@ -2255,7 +2273,12 @@ UInt32 cWorld::SpawnMinecart(double a_X, double a_Y, double a_Z, int a_MinecartT
return cEntity::INVALID_ID;
}
} // switch (a_MinecartType)
Minecart->Initialize(*this);
if (!Minecart->Initialize(*this))
{
delete Minecart;
Minecart = nullptr;
return cEntity::INVALID_ID;
}
return Minecart->GetUniqueID();
}

Expand All @@ -2273,6 +2296,7 @@ UInt32 cWorld::SpawnBoat(double a_X, double a_Y, double a_Z)
if (!Boat->Initialize(*this))
{
delete Boat;
Boat = nullptr;
return cEntity::INVALID_ID;
}
return Boat->GetUniqueID();
Expand All @@ -2284,7 +2308,12 @@ UInt32 cWorld::SpawnBoat(double a_X, double a_Y, double a_Z)
UInt32 cWorld::SpawnPrimedTNT(double a_X, double a_Y, double a_Z, int a_FuseTicks, double a_InitialVelocityCoeff)
{
cTNTEntity * TNT = new cTNTEntity(a_X, a_Y, a_Z, a_FuseTicks);
TNT->Initialize(*this);
if (!TNT->Initialize(*this))
{
delete TNT;
TNT = nullptr;
return cEntity::INVALID_ID;
}
TNT->SetSpeed(
a_InitialVelocityCoeff * (GetTickRandomNumber(2) - 1), /** -1, 0, 1 */
a_InitialVelocityCoeff * 2,
Expand Down Expand Up @@ -2878,7 +2907,11 @@ void cWorld::SetChunkData(cSetChunkData & a_SetChunkData)
std::swap(a_SetChunkData.GetEntities(), Entities);
for (cEntityList::iterator itr = Entities.begin(), end = Entities.end(); itr != end; ++itr)
{
(*itr)->Initialize(*this);
if (!(*itr)->Initialize(*this))
{
delete *itr;
*itr = nullptr;
}
}

// If a client is requesting this chunk, send it to them:
Expand Down

0 comments on commit 5580d55

Please sign in to comment.