1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2025-06-29 21:47:12 +02:00

Documented the Model type and made minor fixes.

This commit is contained in:
Sandu Liviu Catalin
2015-10-29 22:58:19 +02:00
parent 6cecf4ad77
commit fb00945f01
2 changed files with 246 additions and 70 deletions

View File

@ -12,27 +12,29 @@ const CModel CModel::NIL;
// ------------------------------------------------------------------------------------------------
CModel::CModel() noexcept
: m_ID(SQMOD_UNKNOWN), m_Name()
: m_ID(SQMOD_UNKNOWN)
{
}
CModel::CModel(SQInt32 id) noexcept
: m_ID(VALID_ENTITYGETEX(id, Max)), m_Name(GetModelName(id))
: m_ID(VALID_ENTITYGETEX(id, Max))
{
}
CModel::CModel(const SQChar * name, SQInt32 id) noexcept
: CModel(WeaponToModel(IsWeaponValid(GetWeaponID(name)) ? GetWeaponID(name) : id))
: m_ID(GetWeaponID(name))
{
if (VALID_ENTITYGETEX(m_ID, Max))
{
m_ID = id;
}
}
// ------------------------------------------------------------------------------------------------
CModel::CModel(const CModel & m) noexcept
: m_ID(m.m_ID)
, m_Name(m.m_Name)
, m_Tag(m.m_Tag)
, m_Data(m.m_Data)
{
@ -41,7 +43,6 @@ CModel::CModel(const CModel & m) noexcept
CModel::CModel(CModel && m) noexcept
: m_ID(m.m_ID)
, m_Name(m.m_Name)
, m_Tag(m.m_Tag)
, m_Data(m.m_Data)
{
@ -58,29 +59,25 @@ CModel::~CModel()
CModel & CModel::operator = (const CModel & m) noexcept
{
m_ID = m.m_ID;
m_Name = m.m_Name;
m_Tag = m.m_Tag;
m_Data = m.m_Data;
return *this;
}
CModel & CModel::operator = (CModel && m) noexcept
{
m_ID = m.m_ID;
m_Name = m.m_Name;
m_Tag = m.m_Tag;
m_Data = m.m_Data;
return *this;
}
// ------------------------------------------------------------------------------------------------
CModel & CModel::operator = (SQInt32 id) noexcept
{
if (m_ID != id)
{
m_Name = GetModelName(id);
m_ID = id;
}
m_ID = VALID_ENTITYGETEX(id, Max);
return *this;
}
@ -119,13 +116,24 @@ bool CModel::operator >= (const CModel & m) const noexcept
// ------------------------------------------------------------------------------------------------
SQInteger CModel::Cmp(const CModel & m) const noexcept
{
return m_ID == m.m_ID ? 0 : (m_ID > m.m_ID ? 1 : -1);
if (m_ID == m.m_ID)
{
return 0;
}
else if (m_ID > m.m_ID)
{
return 1;
}
else
{
return -1;
}
}
// ------------------------------------------------------------------------------------------------
const SQChar * CModel::ToString() const noexcept
{
return m_Name.c_str();
return GetModelName(m_ID);
}
// ------------------------------------------------------------------------------------------------
@ -136,21 +144,13 @@ SQInteger CModel::GetID() const noexcept
void CModel::SetID(SQInt32 id) noexcept
{
if (m_ID != id)
{
m_Name = GetModelName(id);
m_ID = id;
}
m_ID = VALID_ENTITYGETEX(id, Max);
}
// ------------------------------------------------------------------------------------------------
CModel & CModel::SetnGet(SQInt32 id) noexcept
{
if (m_ID != id)
{
m_Name = GetModelName(id);
m_ID = id;
}
m_ID = VALID_ENTITYGETEX(id, Max);
return *this;
}
@ -202,13 +202,19 @@ void CModel::SetLocalData(SqObj & data) noexcept
// ------------------------------------------------------------------------------------------------
bool CModel::IsValid() const noexcept
{
return (m_ID > 0);
return (VALID_ENTITYEX(m_ID, Max));
}
// ------------------------------------------------------------------------------------------------
const SQChar * CModel::GetName() const noexcept
{
return m_Name.c_str();
return GetModelName(m_ID);
}
// ------------------------------------------------------------------------------------------------
void CModel::SetName(const SQChar * name) noexcept
{
m_ID = -1; /* @TODO Implement! */
}
// ------------------------------------------------------------------------------------------------
@ -255,29 +261,34 @@ bool Register_CModel(HSQUIRRELVM vm)
LogDbg("Beginning registration of <CModel> type");
// Attempt to register the specified type
Sqrat::RootTable(vm).Bind(_SC("CModel"), Sqrat::Class< CModel >(vm, _SC("CModel"))
/* Constructors */
.Ctor()
.Ctor< SQInt32 >()
.Ctor< const SQChar *, SQInt32 >()
/* Metamethods */
.Func(_SC("_cmp"), &CModel::Cmp)
.Func(_SC("_tostring"), &CModel::ToString)
/* Properties */
.Prop(_SC("id"), &CModel::GetID, &CModel::SetID)
.Prop(_SC("gtag"), &CModel::GetGlobalTag, &CModel::SetGlobalTag)
.Prop(_SC("gdata"), &CModel::GetGlobalData, &CModel::SetGlobalData)
.Prop(_SC("ltag"), &CModel::GetLocalTag, &CModel::SetLocalTag)
.Prop(_SC("ldata"), &CModel::GetLocalData, &CModel::SetLocalData)
.Prop(_SC("valid"), &CModel::IsValid)
.Prop(_SC("name"), &CModel::GetName)
.Prop(_SC("name"), &CModel::GetName, &CModel::SetName)
.Prop(_SC("weapon"), &CModel::IsWeapon)
.Prop(_SC("truly_weapon"), &CModel::IsActuallyWeapon)
/* Functions */
.Func(_SC("setng"), &CModel::SetnGet)
.Overload< Reference< CObject > (CModel::*)(SQInt32, const Vector3 &, SQInt32, SQInt32, SqObj &) const >(_SC("object"), &CModel::Object)
.Overload< Reference< CObject > (CModel::*)(SQInt32, SQFloat, SQFloat, SQFloat, SQInt32, SQInt32, SqObj &) const >(_SC("object"), &CModel::Object)
.Overload< Reference< CPickup > (CModel::*)(SQInt32, SQInt32, const Vector3 &, SQInt32, bool, SQInt32, SqObj &) const >(_SC("pickup"), &CModel::Pickup)
.Overload< Reference< CPickup > (CModel::*)(SQInt32, SQInt32, SQFloat, SQFloat, SQFloat, SQInt32, bool, SQInt32, SqObj &) const >(_SC("pickup"), &CModel::Pickup)
/* Overloads */
.Overload< Reference< CObject > (CModel::*)(SQInt32, const Vector3 &, SQInt32, SQInt32, SqObj &) const >
(_SC("object"), &CModel::Object)
.Overload< Reference< CObject > (CModel::*)(SQInt32, SQFloat, SQFloat, SQFloat, SQInt32, SQInt32, SqObj &) const >
(_SC("object"), &CModel::Object)
.Overload< Reference< CPickup > (CModel::*)(SQInt32, SQInt32, const Vector3 &, SQInt32, bool, SQInt32, SqObj &) const >
(_SC("pickup"), &CModel::Pickup)
.Overload< Reference< CPickup > (CModel::*)(SQInt32, SQInt32, SQFloat, SQFloat, SQFloat, SQInt32, bool, SQInt32, SqObj &) const >
(_SC("pickup"), &CModel::Pickup)
);
// Output debugging information
LogDbg("Registration of <CModel> type was successful");