Skip to content

#278: fix blip code inconsistencies and clamp size value for backwards compatibility #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 2, 2018
Merged

#278: fix blip code inconsistencies and clamp size value for backwards compatibility #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c11cdb5
CStaticFuncDefs: make client blip size code consistent with server
patrikjuvonen Jul 29, 2018
0fa3913
CLuaBlipDefs: clamp blip size between 0 and 25 for backwards compatib…
patrikjuvonen Jul 29, 2018
3739f84
CLuaBlipDefs: add a client-side warning for out of bounds size
patrikjuvonen Jul 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 47 additions & 28 deletions Client/mods/deathmatch/logic/CStaticFunctionDefinitions.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4224,58 +4224,77 @@ bool CStaticFunctionDefinitions::GetSFXStatus(eAudioLookupIndex containerIndex,
CClientRadarMarker* CStaticFunctionDefinitions::CreateBlip(CResource& Resource, const CVector& vecPosition, unsigned char ucIcon, unsigned char ucSize,
const SColor color, short sOrdering, unsigned short usVisibleDistance)
{
CClientRadarMarker* pBlip = new CClientRadarMarker(m_pManager, INVALID_ELEMENT_ID, sOrdering, usVisibleDistance);
if (pBlip)
// Valid icon and size?
if (CClientRadarMarkerManager::IsValidIcon(ucIcon) && ucSize <= 25)
{
pBlip->SetParent(Resource.GetResourceDynamicEntity());
pBlip->SetPosition(vecPosition);
pBlip->SetSprite(ucIcon);
pBlip->SetScale(ucSize);
pBlip->SetColor(color);
CClientRadarMarker* pBlip = new CClientRadarMarker(m_pManager, INVALID_ELEMENT_ID, sOrdering, usVisibleDistance);
if (pBlip)
{
pBlip->SetParent(Resource.GetResourceDynamicEntity());
pBlip->SetPosition(vecPosition);
pBlip->SetSprite(ucIcon);
pBlip->SetScale(ucSize);
pBlip->SetColor(color);
}
return pBlip;
}
return pBlip;

return nullptr;
}

CClientRadarMarker* CStaticFunctionDefinitions::CreateBlipAttachedTo(CResource& Resource, CClientEntity& Entity, unsigned char ucIcon, unsigned char ucSize,
const SColor color, short sOrdering, unsigned short usVisibleDistance)
{
CClientRadarMarker* pBlip = new CClientRadarMarker(m_pManager, INVALID_ELEMENT_ID, sOrdering, usVisibleDistance);
if (pBlip)
assert(&Entity);
// Valid icon and size?
if (CClientRadarMarkerManager::IsValidIcon(ucIcon) && ucSize <= 25)
{
pBlip->SetParent(Resource.GetResourceDynamicEntity());
pBlip->AttachTo(&Entity);
pBlip->SetSprite(ucIcon);
pBlip->SetScale(ucSize);
pBlip->SetColor(color);
CClientRadarMarker* pBlip = new CClientRadarMarker(m_pManager, INVALID_ELEMENT_ID, sOrdering, usVisibleDistance);
if (pBlip)
{
pBlip->SetParent(Resource.GetResourceDynamicEntity());
pBlip->AttachTo(&Entity);
pBlip->SetSprite(ucIcon);
pBlip->SetScale(ucSize);
pBlip->SetColor(color);
}
return pBlip;
}
return pBlip;

return nullptr;
}

bool CStaticFunctionDefinitions::SetBlipIcon(CClientEntity& Entity, unsigned char ucIcon)
{
RUN_CHILDREN(SetBlipIcon(**iter, ucIcon))

if (IS_RADARMARKER(&Entity))
if (CClientRadarMarkerManager::IsValidIcon(ucIcon))
{
CClientRadarMarker& Marker = static_cast<CClientRadarMarker&>(Entity);
RUN_CHILDREN(SetBlipIcon(**iter, ucIcon))

Marker.SetSprite(ucIcon);
return true;
if (IS_RADARMARKER(&Entity))
{
CClientRadarMarker& Marker = static_cast<CClientRadarMarker&>(Entity);

Marker.SetSprite(ucIcon);
return true;
}
}

return false;
}

bool CStaticFunctionDefinitions::SetBlipSize(CClientEntity& Entity, unsigned char ucSize)
{
RUN_CHILDREN(SetBlipSize(**iter, ucSize))

if (IS_RADARMARKER(&Entity))
if (ucSize <= 25)
{
CClientRadarMarker& Marker = static_cast<CClientRadarMarker&>(Entity);
RUN_CHILDREN(SetBlipSize(**iter, ucSize))

Marker.SetScale(ucSize);
return true;
if (IS_RADARMARKER(&Entity))
{
CClientRadarMarker& Marker = static_cast<CClientRadarMarker&>(Entity);

Marker.SetScale(ucSize);
return true;
}
}

return false;
Expand Down
25 changes: 19 additions & 6 deletions Client/mods/deathmatch/logic/luadefs/CLuaBlipDefs.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,14 @@ int CLuaBlipDefs::CreateBlip(lua_State* luaVM)
{
CVector vecPosition;
unsigned char ucIcon = 0;
unsigned char ucSize = 2;
int iSize = 2;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

has the size param changed from an unsigned char to int to satisfy Clamp?

Copy link
Contributor Author

@patrikjuvonen patrikjuvonen Aug 1, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That, but also to make sure if you passed a negative value as the argument, it would take that negative value and clamp it to 0 instead of some random value between the min and max depending on the integer overflow amount.

SColorRGBA color(255, 0, 0, 255);
int iOrdering = 0;
int iVisibleDistance = 16383;
CScriptArgReader argStream(luaVM);
argStream.ReadVector3D(vecPosition);
argStream.ReadNumber(ucIcon, 0);
argStream.ReadNumber(ucSize, 2);
argStream.ReadNumber(iSize, 2);
argStream.ReadNumber(color.R, 255);
argStream.ReadNumber(color.G, 0);
argStream.ReadNumber(color.B, 0);
Expand All @@ -80,6 +80,9 @@ int CLuaBlipDefs::CreateBlip(lua_State* luaVM)
argStream.SetCustomError("Invalid icon");
}

if (iSize < 0 || iSize > 25)
argStream.SetCustomWarning(SString("Blip size beyond 25 is no longer supported (got %i). It will be clamped between 0 and 25.", iSize));

if (!argStream.HasErrors())
{
CLuaMain* pLuaMain = m_pLuaManager->GetVirtualMachine(luaVM);
Expand All @@ -88,6 +91,7 @@ int CLuaBlipDefs::CreateBlip(lua_State* luaVM)
CResource* pResource = pLuaMain->GetResource();
if (pResource)
{
unsigned char ucSize = Clamp(0, iSize, 25);
short sOrdering = Clamp(-32768, iOrdering, 32767);
unsigned short usVisibleDistance = Clamp(0, iVisibleDistance, 65535);

Expand Down Expand Up @@ -120,14 +124,14 @@ int CLuaBlipDefs::CreateBlipAttachedTo(lua_State* luaVM)
CClientEntity* pEntity = NULL;
// Default colors and size
unsigned char ucIcon = 0;
unsigned char ucSize = 2;
int iSize = 2;
SColorRGBA color(255, 0, 0, 255);
int iOrdering = 0;
int iVisibleDistance = 16383;
CScriptArgReader argStream(luaVM);
argStream.ReadUserData(pEntity);
argStream.ReadNumber(ucIcon, 0);
argStream.ReadNumber(ucSize, 2);
argStream.ReadNumber(iSize, 2);
argStream.ReadNumber(color.R, 255);
argStream.ReadNumber(color.G, 0);
argStream.ReadNumber(color.B, 0);
Expand All @@ -140,6 +144,9 @@ int CLuaBlipDefs::CreateBlipAttachedTo(lua_State* luaVM)
argStream.SetCustomError("Invalid icon");
}

if (iSize < 0 || iSize > 25)
argStream.SetCustomWarning(SString("Blip size beyond 25 is no longer supported (got %i). It will be clamped between 0 and 25.", iSize));

if (!argStream.HasErrors())
{
CLuaMain* pLuaMain = m_pLuaManager->GetVirtualMachine(luaVM);
Expand All @@ -148,6 +155,7 @@ int CLuaBlipDefs::CreateBlipAttachedTo(lua_State* luaVM)
CResource* pResource = pLuaMain->GetResource();
if (pResource)
{
unsigned char ucSize = Clamp(0, iSize, 25);
short sOrdering = Clamp(-32768, iOrdering, 32767);
unsigned short usVisibleDistance = Clamp(0, iVisibleDistance, 65535);

Expand Down Expand Up @@ -303,13 +311,18 @@ int CLuaBlipDefs::SetBlipIcon(lua_State* luaVM)
int CLuaBlipDefs::SetBlipSize(lua_State* luaVM)
{
CClientEntity* pEntity = NULL;
unsigned char ucSize = 0;
int iSize = 0;
CScriptArgReader argStream(luaVM);
argStream.ReadUserData(pEntity);
argStream.ReadNumber(ucSize);
argStream.ReadNumber(iSize);

if (iSize < 0 || iSize > 25)
argStream.SetCustomWarning(SString("Blip size beyond 25 is no longer supported (got %i). It will be clamped between 0 and 25.", iSize));

if (!argStream.HasErrors())
{
unsigned char ucSize = Clamp(0, iSize, 25);

if (CStaticFunctionDefinitions::SetBlipSize(*pEntity, ucSize))
{
lua_pushboolean(luaVM, true);
Expand Down
20 changes: 13 additions & 7 deletions Server/mods/deathmatch/logic/luadefs/CLuaBlipDefs.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ void CLuaBlipDefs::AddClass(lua_State* luaVM)
int CLuaBlipDefs::CreateBlip(lua_State* luaVM)
{
CVector vecPosition;
unsigned char ucIcon, ucSize;
unsigned char ucIcon;
int iSize;
SColorRGBA color(255, 0, 0, 255);
int iOrdering;
int iVisibleDistance;
Expand All @@ -72,7 +73,7 @@ int CLuaBlipDefs::CreateBlip(lua_State* luaVM)
CScriptArgReader argStream(luaVM);
argStream.ReadVector3D(vecPosition);
argStream.ReadNumber(ucIcon, 0);
argStream.ReadNumber(ucSize, 2);
argStream.ReadNumber(iSize, 2);
argStream.ReadNumber(color.R, color.R);
argStream.ReadNumber(color.G, color.G);
argStream.ReadNumber(color.B, color.B);
Expand All @@ -97,6 +98,7 @@ int CLuaBlipDefs::CreateBlip(lua_State* luaVM)
CResource* pResource = pLuaMain->GetResource();
if (pResource)
{
unsigned char ucSize = Clamp(0, iSize, 25);
short sOrdering = Clamp(-32768, iOrdering, 32767);
unsigned short usVisibleDistance = Clamp(0, iVisibleDistance, 65535);

Expand Down Expand Up @@ -125,7 +127,8 @@ int CLuaBlipDefs::CreateBlip(lua_State* luaVM)
int CLuaBlipDefs::CreateBlipAttachedTo(lua_State* luaVM)
{
CElement* pElement;
unsigned char ucIcon, ucSize;
unsigned char ucIcon;
int iSize;
SColorRGBA color(255, 0, 0, 255);
int iOrdering;
int iVisibleDistance;
Expand All @@ -134,7 +137,7 @@ int CLuaBlipDefs::CreateBlipAttachedTo(lua_State* luaVM)
CScriptArgReader argStream(luaVM);
argStream.ReadUserData(pElement);
argStream.ReadNumber(ucIcon, 0);
argStream.ReadNumber(ucSize, 2);
argStream.ReadNumber(iSize, 2);
argStream.ReadNumber(color.R, color.R);
argStream.ReadNumber(color.G, color.G);
argStream.ReadNumber(color.B, color.B);
Expand All @@ -156,6 +159,7 @@ int CLuaBlipDefs::CreateBlipAttachedTo(lua_State* luaVM)
CResource* resource = m_pLuaManager->GetVirtualMachineResource(luaVM);
if (resource)
{
unsigned char ucSize = Clamp(0, iSize, 25);
short sOrdering = Clamp(-32768, iOrdering, 32767);
unsigned short usVisibleDistance = Clamp(0, iVisibleDistance, 65535);

Expand Down Expand Up @@ -325,15 +329,17 @@ int CLuaBlipDefs::SetBlipIcon(lua_State* luaVM)

int CLuaBlipDefs::SetBlipSize(lua_State* luaVM)
{
CElement* pElement;
unsigned char ucSize;
CElement* pElement;
int iSize;

CScriptArgReader argStream(luaVM);
argStream.ReadUserData(pElement);
argStream.ReadNumber(ucSize);
argStream.ReadNumber(iSize);

if (!argStream.HasErrors())
{
unsigned char ucSize = Clamp(0, iSize, 25);

if (CStaticFunctionDefinitions::SetBlipSize(pElement, ucSize))
{
lua_pushboolean(luaVM, true);
Expand Down