UNLOZE/sourcemod
9
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add a OnPlayerRunCmdPre forward (#1760)

Browse Source 
Adds an OnPlayerRunCmdPre forward in order for plugins to be able to hook OnPlayerRunCmd with the guarantee that none of the parameters have been modified by other plugins. As such, OnPlayerRunCmdPre's parameters cannot be modified and are read-only. 

Plugins that wish to use OnPlayerRunCmdPre can maintain backwards compatibility with SourceMod 1.10 by falling back to OnPlayerRunCmd if the Pre variant was never fired.
This commit is contained in:
domino_
2022-04-25 14:00:53 -07:00
committed by GitHub
parent a1ad9e1acf
commit b057580a62
3 changed files with 85 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
extensions/sdktools/hooks.cpp
+67 -30
View File
@@ -69,6 +69,7 @@ CHookManager::CHookManager()
: replay_enabled("replay_enabled", false)
#endif
{
m_usercmdsPreFwd = NULL;
m_usercmdsFwd = NULL;
m_usercmdsPostFwd = NULL;
m_netFileSendFwd = NULL;
@@ -97,6 +98,19 @@ void CHookManager::Initialize()
plsys->AddPluginsListener(this);
sharesys->AddCapabilityProvider(myself, this, FEATURECAP_PLAYERRUNCMD_11PARAMS);
m_usercmdsPreFwd = forwards->CreateForward("OnPlayerRunCmdPre", ET_Ignore, 11, NULL,
Param_Cell, // int client
Param_Cell, // int buttons
Param_Cell, // int impulse
Param_Array, // float vel[3]
Param_Array, // float angles[3]
Param_Cell, // int weapon
Param_Cell, // int subtype
Param_Cell, // int cmdnum
Param_Cell, // int tickcount
Param_Cell, // int seed
Param_Array); // int mouse[2]
m_usercmdsFwd = forwards->CreateForward("OnPlayerRunCmd", ET_Event, 11, NULL,
Param_Cell, // client
@@ -179,6 +193,7 @@ void CHookManager::Shutdown()
}
#endif
forwards->ReleaseForward(m_usercmdsPreFwd);
forwards->ReleaseForward(m_usercmdsFwd);
forwards->ReleaseForward(m_usercmdsPostFwd);
forwards->ReleaseForward(m_netFileSendFwd);
@@ -283,7 +298,10 @@ void CHookManager::PlayerRunCmd(CUserCmd *ucmd, IMoveHelper *moveHelper)
RETURN_META(MRES_IGNORED);
}
if (m_usercmdsFwd->GetFunctionCount() == 0)
bool hasUsercmdsPreFwds = (m_usercmdsPreFwd->GetFunctionCount() > 0);
bool hasUsercmdsFwds = (m_usercmdsFwd->GetFunctionCount() > 0);
if (!hasUsercmdsPreFwds && !hasUsercmdsFwds)
{
RETURN_META(MRES_IGNORED);
}
@@ -311,34 +329,53 @@ void CHookManager::PlayerRunCmd(CUserCmd *ucmd, IMoveHelper *moveHelper)
cell_t vel[3] = {sp_ftoc(ucmd->forwardmove), sp_ftoc(ucmd->sidemove), sp_ftoc(ucmd->upmove)};
cell_t angles[3] = {sp_ftoc(ucmd->viewangles.x), sp_ftoc(ucmd->viewangles.y), sp_ftoc(ucmd->viewangles.z)};
cell_t mouse[2] = {ucmd->mousedx, ucmd->mousedy};
m_usercmdsFwd->PushCell(client);
m_usercmdsFwd->PushCellByRef(&ucmd->buttons);
m_usercmdsFwd->PushCellByRef(&impulse);
m_usercmdsFwd->PushArray(vel, 3, SM_PARAM_COPYBACK);
m_usercmdsFwd->PushArray(angles, 3, SM_PARAM_COPYBACK);
m_usercmdsFwd->PushCellByRef(&ucmd->weaponselect);
m_usercmdsFwd->PushCellByRef(&ucmd->weaponsubtype);
m_usercmdsFwd->PushCellByRef(&ucmd->command_number);
m_usercmdsFwd->PushCellByRef(&ucmd->tick_count);
m_usercmdsFwd->PushCellByRef(&ucmd->random_seed);
m_usercmdsFwd->PushArray(mouse, 2, SM_PARAM_COPYBACK);
m_usercmdsFwd->Execute(&result);
ucmd->impulse = impulse;
ucmd->forwardmove = sp_ctof(vel[0]);
ucmd->sidemove = sp_ctof(vel[1]);
ucmd->upmove = sp_ctof(vel[2]);
ucmd->viewangles.x = sp_ctof(angles[0]);
ucmd->viewangles.y = sp_ctof(angles[1]);
ucmd->viewangles.z = sp_ctof(angles[2]);
ucmd->mousedx = mouse[0];
ucmd->mousedy = mouse[1];
if (result == Pl_Handled)
if (hasUsercmdsPreFwds)
{
RETURN_META(MRES_SUPERCEDE);
m_usercmdsPreFwd->PushCell(client);
m_usercmdsPreFwd->PushCell(ucmd->buttons);
m_usercmdsPreFwd->PushCell(ucmd->impulse);
m_usercmdsPreFwd->PushArray(vel, 3);
m_usercmdsPreFwd->PushArray(angles, 3);
m_usercmdsPreFwd->PushCell(ucmd->weaponselect);
m_usercmdsPreFwd->PushCell(ucmd->weaponsubtype);
m_usercmdsPreFwd->PushCell(ucmd->command_number);
m_usercmdsPreFwd->PushCell(ucmd->tick_count);
m_usercmdsPreFwd->PushCell(ucmd->random_seed);
m_usercmdsPreFwd->PushArray(mouse, 2);
m_usercmdsPreFwd->Execute();
}
if (hasUsercmdsFwds)
{
m_usercmdsFwd->PushCell(client);
m_usercmdsFwd->PushCellByRef(&ucmd->buttons);
m_usercmdsFwd->PushCellByRef(&impulse);
m_usercmdsFwd->PushArray(vel, 3, SM_PARAM_COPYBACK);
m_usercmdsFwd->PushArray(angles, 3, SM_PARAM_COPYBACK);
m_usercmdsFwd->PushCellByRef(&ucmd->weaponselect);
m_usercmdsFwd->PushCellByRef(&ucmd->weaponsubtype);
m_usercmdsFwd->PushCellByRef(&ucmd->command_number);
m_usercmdsFwd->PushCellByRef(&ucmd->tick_count);
m_usercmdsFwd->PushCellByRef(&ucmd->random_seed);
m_usercmdsFwd->PushArray(mouse, 2, SM_PARAM_COPYBACK);
m_usercmdsFwd->Execute(&result);
ucmd->impulse = impulse;
ucmd->forwardmove = sp_ctof(vel[0]);
ucmd->sidemove = sp_ctof(vel[1]);
ucmd->upmove = sp_ctof(vel[2]);
ucmd->viewangles.x = sp_ctof(angles[0]);
ucmd->viewangles.y = sp_ctof(angles[1]);
ucmd->viewangles.z = sp_ctof(angles[2]);
ucmd->mousedx = mouse[0];
ucmd->mousedy = mouse[1];
if (result == Pl_Handled)
{
RETURN_META(MRES_SUPERCEDE);
}
}
RETURN_META(MRES_IGNORED);
@@ -576,7 +613,7 @@ void CHookManager::OnPluginLoaded(IPlugin *plugin)
if (PRCH_enabled)
{
bool changed = false;
if (!PRCH_used && (m_usercmdsFwd->GetFunctionCount() > 0))
if (!PRCH_used && ((m_usercmdsFwd->GetFunctionCount() > 0) || (m_usercmdsPreFwd->GetFunctionCount() > 0)))
{
PRCH_used = true;
changed = true;
@@ -634,7 +671,7 @@ void CHookManager::OnPluginLoaded(IPlugin *plugin)
void CHookManager::OnPluginUnloaded(IPlugin *plugin)
{
if (PRCH_used && !m_usercmdsFwd->GetFunctionCount())
if (PRCH_used && (!m_usercmdsFwd->GetFunctionCount() && !m_usercmdsPreFwd->GetFunctionCount()))
{
for (size_t i = 0; i < m_runUserCmdHooks.size(); ++i)
{
extensions/sdktools/hooks.h
+1
View File
@@ -77,6 +77,7 @@ private:
void NetChannelHook(int client);
private:
IForward *m_usercmdsPreFwd;
IForward *m_usercmdsFwd;
IForward *m_usercmdsPostFwd;
IForward *m_netFileSendFwd;