HedgeDocs - User contributions [en]

Binary Resource

2025-12-02T17:34:29Z

ĐeäTh: Merge HE cells for engine usage of BINA

'''''Binary Resource''''' (or '''BINA''') is a container format for binary data developed by Sonic Team.

== Engines using Binary Resource ==
{| class="wikitable"
|+
!Engine
!Version
!Games
|-
|SoX
|1
|[[Sonic the Hedgehog (2006)]]
|-
| rowspan="2" |Hedgehog Engine
|1
|[[Sonic Colors]]
|-
|2
|[[Sonic Lost World]]
|-
|Hedgehog Engine 2
|2
|
|}

== Specifications ==
'''Binary Resource''' has two known major versions.

== Version 1 ==

=== Header ===
The header consists of the following data structure:
{| class="wikitable"
|+Length: 0x20
!Offset
!Type
!Name
!Description
|-
|0x00
|UInt32
|ResourceSize
|The size of the resource.
|-
|0x04
|UInt32
|RelocTableOffset
|The offset of the relocation table relative to the end of the header.
|-
|0x08
|UInt32
|RelocTableLength
|The length of the relocation table.
|-
|0x0C
|UInt32
|N/A
|Unknown. Usually zero.
|-
|0x10
|UInt32
|ChunkCount
|The total number of chunks in the data section. Only used in '''Sonic Colors'''.
|-
|0x14
|Char[4]
|Version
|The first two characters are skipped, leaving Revision and Endianness.
The endianness character is either '<nowiki/>'''L'''<nowiki/>' or ''''B'''<nowiki/>', for little-endian and big-endian respectively.
|-
|0x18
|Char[4]
|Signature
|Always "BINA".
|-
|0x1C
|UInt32
|N/A
|Unknown. Usually zero.
|}
Due to the nature of the header, you '''must''' read ahead '''0x14''' bytes to read the <code>Version</code> field to get the endianness of the file before proceeding with the rest of the fields at the start of the file.

=== Data Section ===
The data after the header is specific to each file format contained within a '''Binary Resource'''.

All offset fields inside the data section are relative to the end of the header, so you must add the size of the header to the offset to get the absolute offset to where it's pointing to in the file on disk.<syntaxhighlight lang="text">
MyOffset = ReadUInt32() + HeaderSize // HeaderSize = 0x20
</syntaxhighlight>

=== Relocation Table ===
After the data section is a relocation table, which is used by the '''Binary Resource''' loader to locate offsets in the data section to make them absolute pointers. This allows the data section to be mapped directly to a structure without having to read it manually.

The relocation table must be aligned to 4 bytes before and after writing it.

Each entry in the relocation table is encoded as such:
{| class="wikitable"
|+
!Type Bits
!Length
!Minimum
!Maximum
!Description
|-
|0b01000000
|6 bits
|0x00
|0x3F
|The offset is stored in the remaining six bits after the type bits.
|-
|0b10000000
|14 bits
|0x3F
|0x3FFF
|The offset is stored in the remaining six bits after the type bits, including an extra byte.
|-
|0b11000000
|30 bits
|0x3FFF
|0x3FFFFFFF
|The offset is stored in the remaining six bits after the type bits, including an extra three bytes.
|}
To encode an entry in the relocation table, first subtract the current offset with the last offset that was encoded, then bit shift the result to the right by two bits. When encoding the first entry in the relocation table, the last offset will be the size of the header ('''0x20''').<syntaxhighlight lang="text">
EncodedOffset = (CurrentOffset - LastOffset) >> 2
</syntaxhighlight>After this, the value of the encoded offset can be used to determine which type bits are needed to fit it in the relocation table.

=== Footer ===
If the <code>ChunkCount</code> field in the header is non-zero, a footer must be written to the end of the file. The purpose of this footer isn't fully understood, but it only appears to be used in '''Sonic Colors'''.
{| class="wikitable"
|+Length: 0x0C
!Offset
!Type
!Name
!Description
|-
|0x00
|UInt32
|N/A
|Unknown. Always 16.
|-
|0x04
|UInt32
|N/A
|Unknown. Always zero.
|-
|0x08
|Char[4]
|N/A
|Always "bvh\0".
|}
[[Category:File Formats]]

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T22:01:18Z

ĐeäTh:

{{Notice|type=warn|content=These objects are missing images captured in-game.}}

== Unused Objects ==

=== DashRing ===
The large ring object which provides the player a burst of speed found commonly in Sonic games is an object that doesn't exist in Sonic Lost World.

==== MsgDashRingImpulse ====
This is the message type that would have been used by the <code>DashRing</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgDashRingImpulse : fnd::Message
{
public:
enum class EType
{
};

MsgDashRingImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
float outOfControl, float travelTime, EType type) : fnd::Message(0x6004),
origin_(origin), destination_(destination), outOfControl_(outOfControl),
travelTime_(travelTime), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
float outOfControl_;
float travelTime_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== DummySpring ===
The Eggman spring object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace spring
{
enum class SpringType : signed char
{
Normal,
Dummy
};
} // namespace spring

class CObjSpring : CSetObjectListener
{
public:
static CObjSpring* CreateDummy()
{
auto springType = csl::ut::Enum<spring::SpringType::Dummy, signed char>(1);
return new CObjSpring(springType);
}
};

static void* ObjDummySpring_Constructor()
{
CObjSpring::CreateDummy();
}
} // namespace app
</syntaxhighlight>

However during the object's setup the model entry is overwritten by a normal spring.
<syntaxhighlight lang="cpp">namespace app
{
class CObjSpringInfo : CObjInfo
{
public:
static const char* modelNames = { "cmn_obj_spring", "cmn_obj_spring" };
static const char* animationNames = { "cmn_obj_spring", "cmn_obj_spring" };

protected:
void Initialize(GameDocument& document) override
{
auto packfile= ObjUtil::GetPackFile("CommonObject.pac");
for (size_t i = 0; i < 2; i++)
{
models_[i] = ObjUtil::GetModelResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
animations_[i] = ObjUtil::GetAnimationResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
hh::ut::Packfile skeletonPackFile(packfile);
skeletons_[i] = ObjUtil::GetSkeletonResource(modelNames[i], skeletonPackFile);
}
}

private:
csl::ut::FixedArray<hh::gfx::res::ResModel, 2> models_;
csl::ut::FixedArray<hh::gfx::res::ResAnimSkeleton, 2> animations_;
csl::ut::FixedArray<hh::gfx::res::ResSkeleton, 2> skeletons_;
};
} // namespace app
</syntaxhighlight>
The second entry in both <code style="color: green;">modelNames</code> and <code style="color: green;">animationNames</code> is using <code>cmn_obj_spring</code>, which is the normal spring model asset located in <code>sonic2013_0.cpk\CommonObject.pac</code>

This object has identical parameter configuration to the normal Spring object.

=== JumpBoard ===
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
public:
static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

private:
bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0 + field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.origin, normalShot.destination,
boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}

int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)",
0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)",
4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)",
8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
} // namespace app
</syntaxhighlight>

This is identical to the parameters the object can be configured with in Sonic Colors.

==== MsgJumpBoardImpulse ====
This is the message type used by the unused <code>JumpBoard</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgJumpBoardImpulse : fnd::Message
{
public:
enum class EType
{
Normal,
Boost
};

MsgJumpBoardImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
const csl::math::Vector3 boostDestination, float outOfControl, EType type) : fnd::Message(0x6003),
origin_(origin), destination_(destination), boostDestination_(boostDestination),
outOfControl_(outOfControl), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
csl::math::Vector3 boostDestination_;
float outOfControl_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== IronBox ===
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
} // namespace app
</syntaxhighlight>

=== WoodBox ===
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== Used Objects ==

=== GoalRing ===
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
} // namesapce app
</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
} // namesapce app
</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T21:59:38Z

ĐeäTh:

{{Notice|type=warn|content=These objects are missing images captured in-game.}}

== Unused Objects ==

=== DashRing ===
The large ring object which provides the player a burst of speed found commonly in Sonic games is an object that doesn't exist in Sonic Lost World.

==== MsgDashRingImpulse ====
This is the message type that would have been used by the <code>DashRing</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgDashRingImpulse : fnd::Message
{
public:
enum class EType
{
};

MsgDashRingImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
float outOfControl, float travelTime, EType type) : fnd::Message(0x6004),
origin_(origin), destination_(destination), outOfControl_(outOfControl),
travelTime_(travelTime), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
float outOfControl_;
float travelTime_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== DummySpring ===
The Eggman spring object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace spring
{
enum class SpringType : signed char
{
Normal,
Dummy
};
} // namespace spring

class CObjSpring : CSetObjectListener
{
public:
static CObjSpring* CreateDummy()
{
auto springType = csl::ut::Enum<spring::SpringType::Dummy, signed char>(1);
return new CObjSpring(springType);
}
};

static void* ObjDummySpring_Constructor()
{
CObjSpring::CreateDummy();
}
} // namespace app
</syntaxhighlight>

However during the object's setup the model entry is overwritten by a normal spring.
<syntaxhighlight lang="cpp">namespace app
{
class CObjSpringInfo : CObjInfo
{
public:
static const char* modelNames = { "cmn_obj_spring", "cmn_obj_spring" };
static const char* animationNames = { "cmn_obj_spring", "cmn_obj_spring" };

protected:
void Initialize(GameDocument& document) override
{
auto packfile= ObjUtil::GetPackFile("CommonObject.pac");
for (size_t i = 0; i < 2; i++)
{
models_[i] = ObjUtil::GetModelResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
animations_[i] = ObjUtil::GetAnimationResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
hh::ut::Packfile skeletonPackFile(packfile);
skeletons_[i] = ObjUtil::GetSkeletonResource(modelNames[i], skeletonPackFile);
}
}

private:
csl::ut::FixedArray<hh::gfx::res::ResModel, 2> models_;
csl::ut::FixedArray<hh::gfx::res::ResAnimSkeleton, 2> animations_;
csl::ut::FixedArray<hh::gfx::res::ResSkeleton, 2> skeletons_;
};
} // namespace app
</syntaxhighlight>
The second entry in both <code style="color: green;">modelNames</code> and <code style="color: green;">animationNames</code> is using <code>cmn_obj_spring</code>, which is the normal spring model asset located in <code>sonic2013_0.cpk\CommonObject.pac</code>

This object has identical parameter configuration to the normal Spring object.

=== JumpBoard ===
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
public:
static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

private:
bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.origin, normalShot.destination,
boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}

int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)",
0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)",
4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)",
8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
} // namespace app
</syntaxhighlight>

This is identical to the parameters the object can be configured with in Sonic Colors.

==== MsgJumpBoardImpulse ====
This is the message type used by the unused <code>JumpBoard</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgJumpBoardImpulse : fnd::Message
{
public:
enum class EType
{
Normal,
Boost
};

MsgJumpBoardImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
const csl::math::Vector3 boostDestination, float outOfControl, EType type) : fnd::Message(0x6003),
origin_(origin), destination_(destination), boostDestination_(boostDestination),
outOfControl_(outOfControl), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
csl::math::Vector3 boostDestination_;
float outOfControl_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== IronBox ===
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
} // namespace app
</syntaxhighlight>

=== WoodBox ===
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== Used Objects ==

=== GoalRing ===
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
} // namesapce app
</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
} // namesapce app
</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T21:59:14Z

ĐeäTh:

{{Notice|type=warn|content=Capture some images of these objects in-game.}}

== Unused Objects ==

=== DashRing ===
The large ring object which provides the player a burst of speed found commonly in Sonic games is an object that doesn't exist in Sonic Lost World.

==== MsgDashRingImpulse ====
This is the message type that would have been used by the <code>DashRing</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgDashRingImpulse : fnd::Message
{
public:
enum class EType
{
};

MsgDashRingImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
float outOfControl, float travelTime, EType type) : fnd::Message(0x6004),
origin_(origin), destination_(destination), outOfControl_(outOfControl),
travelTime_(travelTime), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
float outOfControl_;
float travelTime_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== DummySpring ===
The Eggman spring object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace spring
{
enum class SpringType : signed char
{
Normal,
Dummy
};
} // namespace spring

class CObjSpring : CSetObjectListener
{
public:
static CObjSpring* CreateDummy()
{
auto springType = csl::ut::Enum<spring::SpringType::Dummy, signed char>(1);
return new CObjSpring(springType);
}
};

static void* ObjDummySpring_Constructor()
{
CObjSpring::CreateDummy();
}
} // namespace app
</syntaxhighlight>

However during the object's setup the model entry is overwritten by a normal spring.
<syntaxhighlight lang="cpp">namespace app
{
class CObjSpringInfo : CObjInfo
{
public:
static const char* modelNames = { "cmn_obj_spring", "cmn_obj_spring" };
static const char* animationNames = { "cmn_obj_spring", "cmn_obj_spring" };

protected:
void Initialize(GameDocument& document) override
{
auto packfile= ObjUtil::GetPackFile("CommonObject.pac");
for (size_t i = 0; i < 2; i++)
{
models_[i] = ObjUtil::GetModelResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
animations_[i] = ObjUtil::GetAnimationResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
hh::ut::Packfile skeletonPackFile(packfile);
skeletons_[i] = ObjUtil::GetSkeletonResource(modelNames[i], skeletonPackFile);
}
}

private:
csl::ut::FixedArray<hh::gfx::res::ResModel, 2> models_;
csl::ut::FixedArray<hh::gfx::res::ResAnimSkeleton, 2> animations_;
csl::ut::FixedArray<hh::gfx::res::ResSkeleton, 2> skeletons_;
};
} // namespace app
</syntaxhighlight>
The second entry in both <code style="color: green;">modelNames</code> and <code style="color: green;">animationNames</code> is using <code>cmn_obj_spring</code>, which is the normal spring model asset located in <code>sonic2013_0.cpk\CommonObject.pac</code>

This object has identical parameter configuration to the normal Spring object.

=== JumpBoard ===
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
public:
static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

private:
bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.origin, normalShot.destination,
boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}

int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)",
0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)",
4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)",
8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
} // namespace app
</syntaxhighlight>

This is identical to the parameters the object can be configured with in Sonic Colors.

==== MsgJumpBoardImpulse ====
This is the message type used by the unused <code>JumpBoard</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgJumpBoardImpulse : fnd::Message
{
public:
enum class EType
{
Normal,
Boost
};

MsgJumpBoardImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
const csl::math::Vector3 boostDestination, float outOfControl, EType type) : fnd::Message(0x6003),
origin_(origin), destination_(destination), boostDestination_(boostDestination),
outOfControl_(outOfControl), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
csl::math::Vector3 boostDestination_;
float outOfControl_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== IronBox ===
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
} // namespace app
</syntaxhighlight>

=== WoodBox ===
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== Used Objects ==

=== GoalRing ===
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
} // namesapce app
</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
} // namesapce app
</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T21:57:43Z

ĐeäTh:

== Unused Objects ==

=== DashRing ===
The large ring object which provides the player a burst of speed found commonly in Sonic games is an object that doesn't exist in Sonic Lost World.

==== MsgDashRingImpulse ====
This is the message type that would have been used by the <code>DashRing</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgDashRingImpulse : fnd::Message
{
public:
enum class EType
{
};

MsgDashRingImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
float outOfControl, float travelTime, EType type) : fnd::Message(0x6004),
origin_(origin), destination_(destination), outOfControl_(outOfControl),
travelTime_(travelTime), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
float outOfControl_;
float travelTime_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== DummySpring ===
The Eggman spring object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace spring
{
enum class SpringType : signed char
{
Normal,
Dummy
};
} // namespace spring

class CObjSpring : CSetObjectListener
{
public:
static CObjSpring* CreateDummy()
{
auto springType = csl::ut::Enum<spring::SpringType::Dummy, signed char>(1);
return new CObjSpring(springType);
}
};

static void* ObjDummySpring_Constructor()
{
CObjSpring::CreateDummy();
}
} // namespace app
</syntaxhighlight>

However during the object's setup the model entry is overwritten by a normal spring.
<syntaxhighlight lang="cpp">namespace app
{
class CObjSpringInfo : CObjInfo
{
public:
static const char* modelNames = { "cmn_obj_spring", "cmn_obj_spring" };
static const char* animationNames = { "cmn_obj_spring", "cmn_obj_spring" };

protected:
void Initialize(GameDocument& document) override
{
auto packfile= ObjUtil::GetPackFile("CommonObject.pac");
for (size_t i = 0; i < 2; i++)
{
models_[i] = ObjUtil::GetModelResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
animations_[i] = ObjUtil::GetAnimationResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
hh::ut::Packfile skeletonPackFile(packfile);
skeletons_[i] = ObjUtil::GetSkeletonResource(modelNames[i], skeletonPackFile);
}
}

private:
csl::ut::FixedArray<hh::gfx::res::ResModel, 2> models_;
csl::ut::FixedArray<hh::gfx::res::ResAnimSkeleton, 2> animations_;
csl::ut::FixedArray<hh::gfx::res::ResSkeleton, 2> skeletons_;
};
} // namespace app
</syntaxhighlight>
The second entry in both <code style="color: green;">modelNames</code> and <code style="color: green;">animationNames</code> is using <code>cmn_obj_spring</code>, which is the normal spring model asset located in <code>sonic2013_0.cpk\CommonObject.pac</code>

This object has identical parameter configuration to the normal Spring object.

=== JumpBoard ===
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
public:
static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

private:
bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.origin, normalShot.destination,
boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}

int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)",
0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)",
4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)",
8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
} // namespace app
</syntaxhighlight>

This is identical to the parameters the object can be configured with in Sonic Colors.

==== MsgJumpBoardImpulse ====
This is the message type used by the unused <code>JumpBoard</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgJumpBoardImpulse : fnd::Message
{
public:
enum class EType
{
Normal,
Boost
};

MsgJumpBoardImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
const csl::math::Vector3 boostDestination, float outOfControl, EType type) : fnd::Message(0x6003),
origin_(origin), destination_(destination), boostDestination_(boostDestination),
outOfControl_(outOfControl), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
csl::math::Vector3 boostDestination_;
float outOfControl_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== IronBox ===
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
} // namespace app
</syntaxhighlight>

=== WoodBox ===
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== Used Objects ==

=== GoalRing ===
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
} // namesapce app
</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
} // namesapce app
</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T21:56:38Z

ĐeäTh:

== Unused Objects ==

=== DashRing ===
The iron box object found commonly in Sonic games is an object that doesn't exist in Sonic Lost World.

==== MsgDashRingImpulse ====
This is the message type that would have been used by the <code>DashRing</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgDashRingImpulse : fnd::Message
{
public:
enum class EType
{
};

MsgDashRingImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
float outOfControl, float travelTime, EType type) : fnd::Message(0x6004),
origin_(origin), destination_(destination), outOfControl_(outOfControl),
travelTime_(travelTime), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
float outOfControl_;
float travelTime_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== DummySpring ===
The Eggman spring object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace spring
{
enum class SpringType : signed char
{
Normal,
Dummy
};
} // namespace spring

class CObjSpring : CSetObjectListener
{
public:
static CObjSpring* CreateDummy()
{
auto springType = csl::ut::Enum<spring::SpringType::Dummy, signed char>(1);
return new CObjSpring(springType);
}
};

static void* ObjDummySpring_Constructor()
{
CObjSpring::CreateDummy();
}
} // namespace app
</syntaxhighlight>

However during the object's setup the model entry is overwritten by a normal spring.
<syntaxhighlight lang="cpp">namespace app
{
class CObjSpringInfo : CObjInfo
{
public:
static const char* modelNames = { "cmn_obj_spring", "cmn_obj_spring" };
static const char* animationNames = { "cmn_obj_spring", "cmn_obj_spring" };

protected:
void Initialize(GameDocument& document) override
{
auto packfile= ObjUtil::GetPackFile("CommonObject.pac");
for (size_t i = 0; i < 2; i++)
{
models_[i] = ObjUtil::GetModelResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
animations_[i] = ObjUtil::GetAnimationResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
hh::ut::Packfile skeletonPackFile(packfile);
skeletons_[i] = ObjUtil::GetSkeletonResource(modelNames[i], skeletonPackFile);
}
}

private:
csl::ut::FixedArray<hh::gfx::res::ResModel, 2> models_;
csl::ut::FixedArray<hh::gfx::res::ResAnimSkeleton, 2> animations_;
csl::ut::FixedArray<hh::gfx::res::ResSkeleton, 2> skeletons_;
};
} // namespace app
</syntaxhighlight>
The second entry in both <code style="color: green;">modelNames</code> and <code style="color: green;">animationNames</code> is using <code>cmn_obj_spring</code>, which is the normal spring model asset located in <code>sonic2013_0.cpk\CommonObject.pac</code>

This object has identical parameter configuration to the normal Spring object.

=== JumpBoard ===
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
public:
static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

private:
bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.origin, normalShot.destination,
boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}

int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)",
0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)",
4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)",
8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
} // namespace app
</syntaxhighlight>

This is identical to the parameters the object can be configured with in Sonic Colors.

==== MsgJumpBoardImpulse ====
This is the message type used by the unused <code>JumpBoard</code> object and is a leftover from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace xgame
{
class MsgJumpBoardImpulse : fnd::Message
{
public:
enum class EType
{
Normal,
Boost
};

MsgJumpBoardImpulse(const csl::math::Vector3& origin, const csl::math::Vector3& destination,
const csl::math::Vector3 boostDestination, float outOfControl, EType type) : fnd::Message(0x6003),
origin_(origin), destination_(destination), boostDestination_(boostDestination),
outOfControl_(outOfControl), type_(type)
{
handled = false;
}

private:
csl::math::Vector3 origin_;
csl::math::Vector3 destination_;
csl::math::Vector3 boostDestination_;
float outOfControl_;
EType type_;

public:
bool handled;
};
} // namespace xgame
} // namespace app
</syntaxhighlight>

=== IronBox ===
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
} // namespace app
</syntaxhighlight>

=== WoodBox ===
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
} // namespace app
</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== Used Objects ==

=== GoalRing ===
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
} // namesapce app
</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
} // namesapce app
</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T21:34:09Z

ĐeäTh:

== Unused Objects ==

=== DummySpring ===
The Eggman spring object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace spring
{
enum class SpringType : signed char
{
Normal,
Dummy
};
}

class CObjSpring : CSetObjectListener
{
public:
static CObjSpring* CreateDummy()
{
auto springType = csl::ut::Enum<spring::SpringType::Dummy, signed char>(1);
return new CObjSpring(springType);
}
};

static void* ObjDummySpring_Constructor()
{
CObjSpring::CreateDummy();
}
}
</syntaxhighlight>

However during the object's setup the model entry is overwritten by a normal spring.
<syntaxhighlight lang="cpp">namespace app
{
class CObjSpringInfo : CObjInfo
{
public:
static const char* modelNames = { "cmn_obj_spring", "cmn_obj_spring" };
static const char* animationNames = { "cmn_obj_spring", "cmn_obj_spring" };

private:
csl::ut::FixedArray<hh::gfx::res::ResModel, 2> models_;
csl::ut::FixedArray<hh::gfx::res::ResAnimSkeleton, 2> animations_;
csl::ut::FixedArray<hh::gfx::res::ResSkeleton, 2> skeletons_;

protected:
void Initialize(GameDocument& document) override
{
auto packfile= ObjUtil::GetPackFile("CommonObject.pac");
for (size_t i = 0; i < 2; i++)
{
models_[i] = ObjUtil::GetModelResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
animations_[i] = ObjUtil::GetAnimationResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
hh::ut::Packfile skeletonPackFile(packfile);
skeletons_[i] = ObjUtil::GetSkeletonResource(modelNames[i], skeletonPackFile);
}
}
};
}
</syntaxhighlight>
As can be seen above, the second entry in both <code style="color: green;">modelNames</code> and <code style="color: green;">animationNames</code> is using <code>cmn_obj_spring</code>, which is the normal spring model asset located in <code>sonic2013_0.cpk\CommonObject.pac</code>

This object has identical parameter configuration to the normal Spring object.

=== JumpBoard ===
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
private:
int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;

static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.startPosition, normalShot.destination,
boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)",
0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)",
4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)",
8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
}</syntaxhighlight>
This is identical to the parameters the object can be configured with in Sonic Colors.

=== IronBox ===
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
}</syntaxhighlight>

=== WoodBox ===
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== Used Objects ==

=== GoalRing ===
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
}</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
}</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T21:31:56Z

ĐeäTh:

== Unused Objects ==

=== DummySpring ===
The Eggman spring object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
namespace spring
{
enum class SpringType : signed char
{
Normal,
Dummy
};
}

class CObjSpring : CSetObjectListener
{
public:
static CObjSpring* CreateDummy()
{
auto springType = csl::ut::Enum<spring::SpringType::Dummy, signed char>(1);
return new CObjSpring(springType);
}
};

static void* ObjDummySpring_Constructor()
{
CObjSpring::CreateDummy();
}
}
</syntaxhighlight>

However during the object's setup the model entry is overwritten by a normal spring.
<syntaxhighlight lang="cpp">namespace app
{
class CObjSpringInfo : CObjInfo
{
public:
static const char* modelNames = { "cmn_obj_spring", "cmn_obj_spring" };
static const char* animationNames = { "cmn_obj_spring", "cmn_obj_spring" };

private:
csl::ut::FixedArray<hh::gfx::res::ResModel, 2> models_;
csl::ut::FixedArray<hh::gfx::res::ResAnimSkeleton, 2> animations_;
csl::ut::FixedArray<hh::gfx::res::ResSkeleton, 2> skeletons_;

protected:
void Initialize(GameDocument& document) override
{
auto packfile= ObjUtil::GetPackFile("CommonObject.pac");
for (size_t i = 0; i < 2; i++)
{
models_[i] = ObjUtil::GetModelResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
animations_[i] = ObjUtil::GetAnimationResource(modelNames[i], packfile);
}

for (size_t i = 0; i < 2; i++)
{
hh::ut::Packfile skeletonPackFile(packfile);
skeletons_[i] = ObjUtil::GetSkeletonResource(modelNames[i], skeletonPackFile);
}
}
};
}
</syntaxhighlight>
As can be seen above, the second entry in both <code style="color: green;">modelNames</code> and <code style="color: green;">animationNames</code> is using <code>cmn_obj_spring</code>, which is the normal spring model asset located in <code>sonic2013_0.cpk\CommonObject.pac</code>

=== JumpBoard ===
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
private:
int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;

static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.startPosition, normalShot.destination,
boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)",
0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)",
4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)",
8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
}</syntaxhighlight>
This is identical to the parameters the object can be configured with in Sonic Colors.

=== IronBox ===
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
}</syntaxhighlight>

=== WoodBox ===
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== Used Objects ==

=== GoalRing ===
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
}</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
}</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T21:02:21Z

ĐeäTh:

== WoodBox ==
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== IronBox ==
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
}</syntaxhighlight>

== JumpBoard ==
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
private:
int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;

static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.startPosition, normalShot.destination,
boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)",
0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)",
4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)",
8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
}</syntaxhighlight>
This is identical to the parameters the object can be configured with in Sonic Colors.

== GoalRing ==
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
}</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
}</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T20:55:01Z

ĐeäTh:

== WoodBox ==
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

This object has no parameters to configure.

== IronBox ==
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
}</syntaxhighlight>

== JumpBoard ==
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
private:
int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;

static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.startPosition, normalShot.destination, boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)", 0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)", 4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)", 8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
}</syntaxhighlight>
This is identical to the parameters the object can be configured with in Sonic Colors.

== GoalRing ==
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
}</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void app::paramMap_ObjGoalRing(SetEd::CResClass resource)
{
AddParamBool(resource, "IsMessageON", "メッセージで起動", 0, false);
AddParamTarget(resource, "GoalRingBattleInfo", "対戦用情報Obj(GoalRingBattleInfo)", 4);
}
}</syntaxhighlight>

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T20:51:58Z

ĐeäTh:

== WoodBox ==
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

== IronBox ==
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
void paramMap_ObjIronBox(SetEd::CResClass resource)
{
AddParamUint32(resource, "BoxNumX", "箱の数(X軸)", 0, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumY", "箱の数(Y軸)", 4, 1, 1, 100, 1);
AddParamUint32(resource, "BoxNumZ", "箱の数(Z軸)", 8, 1, 1, 100, 1);
}
}</syntaxhighlight>

== JumpBoard ==
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
private:
int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;

static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.startPosition, normalShot.destination, boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

The object can be configured with the following parameters:
<syntaxhighlight lang="cpp">namespace app
{
static const char* enumDescriptions[] = { "Sサイズ", "Mサイズ", "Lサイズ" };

void paramMap_ObjJumpBoard(SetEd::CResClass resource)
{
AddParamFloat(resource, "ImpulseSpeedOnNormal", "プレイヤーに与える速度(通常時)", 0, 350.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "ImpulseSpeedOnBoost", "プレイヤーに与える速度(ブースト時)", 4, 500.0f, 0.0f, 100000.0f, 10.0f);
AddParamFloat(resource, "OutOfControl", "制御不可時間(秒)", 8, 0.25f, 0.0f, 100000.0f, 0.01f);
AddParamEnum(resource, "SizeType", "大きさ", 12, enumDescriptions, 3, 0);
}
}</syntaxhighlight>

== GoalRing ==
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
}</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T20:40:44Z

ĐeäTh:

== WoodBox ==
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model, however there are no models included for when the object is broken by the player. This is because in Sonic Colors the breaking uses particles to display broken pieces and the underlying code still references the particle file from that game.
<syntaxhighlight lang="cpp">namespace app
{
class CObjWoodBox : CSetObjectListener
{
private:
bool ProcMsgDamage(xgame::MsgDamage& message)
{
csl::math::Vector3 position = GetGOC<fnd::GOCTransform>()->frame.transform.GetTranslation();
message.SetReply(position, true);

GetGOC<game::GOCEffect>()->CreateEffect("woodbox_ya");
GetGOC<game::GOCSound>()->Play3D("obj_woodboxbrk", 0.0f);

SetStatusRetire();
Kill();

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">woodbox_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

== IronBox ==
The iron box object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model.

== JumpBoard ==
The dash board object found commonly in Sonic games is an unused object in Sonic Lost World carried over from Sonic Colors. The model that it uses has been swapped for the Sonic Generations model. The underlying code still references the particle and sound files from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjJumpBoard : CSetObjectListener
{
private:
int sizeType = 0;
csl::math::Vector3 field3A0;
float field3B0;
game::GOCLauncher* launcher = nullptr;

static const char* particleNames[] = { "jumppanel_ya_30s", "jumppanel_ya_30m", "jumppanel_ya_30l" };

bool ProcMsgHitEventCollision(xgame::MsgHitEventCollision& message)
{
csl::math::Vector3 position;
xgame::MsgGetPosition getPositionMsg(&position);
SendMessageImm(message.sender, getPositionMsg);
if (field3B0+ field3A0.dot(position) >= -0.000001)
{
return true;
}

auto& normalShot = launcher->getShotInfo("normal");
auto& boostShot = launcher->getShotInfo("boost");

xgame::MsgJumpBoardImpulse impulseMsg(normalShot.startPosition, normalShot.destination, boostShot.destination, normalShot.travelTime, xgame::MsgJumpBoardImpulse::EType::Normal);
SendMessageImm(message.sender, impulseMsg);
if(impulseMsg.handled)
{
auto* effect = GetGOC<game::GOCEffect>();
game::EffectCreateInfo effectInfo;
effectInfo.name = particleNames[size_type];
effectInfo.rotation = csl::math::Quaternion(M_PI);
effectInfo.field30 = true;
effect->CreateEffectEx(effectInfo);

GetGOC<game::GOCSound>()->Play3D("objsn_jumpboard", 0.0f);
}

return true;
}
};
}</syntaxhighlight>
The <code style="color: green;">jumppanel_ya_30s</code>, <code style="color: green;">jumppanel_ya_30m</code> and <code style="color: green;">jumppanel_ya_30l</code> particle files can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

The <code style="color: green;">objsn_jumpboard</code> sound file can be located within <code>sonic2010_0.cpk\sound\se_object_common.csb</code> inside of Sonic Colors' files.

== GoalRing ==
The goal ring object found commonly in Sonic games is an object in Sonic Lost World's multiplayer mode carried over from Sonic Colors. The underlying code still references the particle file from Sonic Colors.
<syntaxhighlight lang="cpp">namespace app
{
class CObjGoalRing : CSetObjectListener
{
private:
void PlayEffect()
{
auto* visualModel = GetGOC<fnd::GOCVisualModel>();

auto* effect = GetGOC<game::GOCEffect>();
effectInfo.name = "goalring_ya";
effectInfo.visual = visualModel;
effectInfo.field30 = false;
effect->CreateEffectLoopEx(effectInfo);
}
};
}</syntaxhighlight>
The <code style="color: green;">goalring_ya</code> particle file can be located within <code>sonic2010_0.cpk\common_object.arc\ob_common.breff</code> inside of Sonic Colors' files.

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T20:26:31Z

ĐeäTh:

Sonic Colors Leftover Objects in Sonic Lost World

2025-05-10T19:33:57Z

ĐeäTh: Created page with "== Woodbox == The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World"

== Woodbox ==
The wooden box object found commonly in Sonic games is an unused object in Sonic Lost World

Sonic Lost World

2025-05-10T19:32:54Z

ĐeäTh:

== Tools ==

=== General ===

* [[hhdxml]] (*.hhd)

=== Collision ===

* [[Collision2fbx (Sonic Lost World)|collision2fbx]] (*.hkx)

=== Materials ===

* [[GensMaterial2Slw]] (*.material)

=== Models ===

* [[Shadow Model Converter]] (*.model)

== Guides ==
N/A

== Documentation ==
N/A

== Discoveries ==

=== Cutscenes ===

* [[Real-Time Cutscene Levels in Sonic Lost World|Real-Time Cutscene Levels]]

=== Levels ===

* [[Sonic Colors Leftover Levels in Sonic Lost World|Colors Leftovers]]
* [[Sonic Lost World Test Levels|Test Levels]]
* [[Sonic Lost World Deleted Levels|Deleted Levels]]
* [[Sonic Lost World Original Level Order|Original Level Order]]

=== Objects ===

* [[Sonic Colors Leftover Objects in Sonic Lost World|Colors Leftovers]]