mirror of
https://github.com/Mauler125/r5sdk.git
synced 2025-02-09 19:15:03 +01:00
29ca97f6b0
* Renamed 'SetEncKeyAndConnect' to 'ConnectToListedServer'. * Renamed 'JoinPrivateServerFromMenu' to 'ConnectToHiddenServer'. * Renamed 'GetPrivateServerMessage' to 'GetHiddenServerConnectStatus'. * Cache game server ref in 'ConnectToListedServer'.
365 lines
18 KiB
C++
365 lines
18 KiB
C++
//=============================================================================//
|
|
//
|
|
// Purpose: Script VM
|
|
//
|
|
//=============================================================================//
|
|
#include "core/stdafx.h"
|
|
#include "tier0/frametask.h"
|
|
#include "tier1/cvar.h"
|
|
#include "squirrel/sqapi.h"
|
|
#include "squirrel/sqinit.h"
|
|
#include "squirrel/sqscript.h"
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: registers global constant for target context
|
|
// Input : *v -
|
|
// *name -
|
|
// value -
|
|
//---------------------------------------------------------------------------------
|
|
SQRESULT Script_RegisterConstant(CSquirrelVM* s, const SQChar* name, SQInteger value)
|
|
{
|
|
return v_Script_RegisterConstant(s, name, value);
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: registers and exposes code functions to target context
|
|
// Input : *s -
|
|
// *scriptname -
|
|
// *nativename -
|
|
// *helpstring -
|
|
// *returntype -
|
|
// *arguments -
|
|
// *functor -
|
|
//---------------------------------------------------------------------------------
|
|
SQRESULT Script_RegisterFunction(CSquirrelVM* s, const SQChar* scriptname, const SQChar* nativename,
|
|
const SQChar* helpstring, const SQChar* returntype, const SQChar* parameters, void* functor)
|
|
{
|
|
ScriptFunctionBinding_t* binding = MemAllocSingleton()->Alloc<ScriptFunctionBinding_t>(sizeof(ScriptFunctionBinding_t));
|
|
memset(binding, '\0', sizeof(ScriptFunctionBinding_t));
|
|
|
|
binding->_scriptname = scriptname;
|
|
binding->_nativename = nativename;
|
|
binding->_helpstring = helpstring;
|
|
binding->_returntype = returntype;
|
|
binding->_parameters = parameters;
|
|
binding->_functor = functor;
|
|
binding->_nparamscheck = 5;
|
|
|
|
SQRESULT results = v_Script_RegisterFunction(s, binding, 1);
|
|
MemAllocSingleton()->Free<ScriptFunctionBinding_t>(binding);
|
|
|
|
return results;
|
|
}
|
|
|
|
#ifndef CLIENT_DLL
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: registers script functions in SERVER context
|
|
// Input : *s -
|
|
//---------------------------------------------------------------------------------
|
|
void Script_RegisterServerFunctions(CSquirrelVM* s)
|
|
{
|
|
Script_RegisterFunction(s, "SDKNativeTest", "Script_SDKNativeTest", "Native SERVER test function", "void", "", &VSquirrel::SHARED::SDKNativeTest);
|
|
Script_RegisterFunction(s, "GetSDKVersion", "Script_GetSDKVersion", "Gets the SDK version as a string", "string", "", &VSquirrel::SHARED::GetSDKVersion);
|
|
|
|
Script_RegisterFunction(s, "GetNumHumanPlayers", "Script_GetNumHumanPlayers", "Gets the number of human players on the server", "int", "", &VSquirrel::SERVER::GetNumHumanPlayers);
|
|
Script_RegisterFunction(s, "GetNumFakeClients", "Script_GetNumFakeClients", "Gets the number of bot players on the server", "int", "", &VSquirrel::SERVER::GetNumFakeClients);
|
|
|
|
Script_RegisterFunction(s, "GetAvailableMaps", "Script_GetAvailableMaps", "Gets an array of all available maps", "array< string >", "", &VSquirrel::SHARED::GetAvailableMaps);
|
|
Script_RegisterFunction(s, "GetAvailablePlaylists", "Script_GetAvailablePlaylists", "Gets an array of all available playlists", "array< string >", "", &VSquirrel::SHARED::GetAvailablePlaylists);
|
|
|
|
Script_RegisterFunction(s, "KickPlayerByName", "Script_KickPlayerByName", "Kicks a player from the server by name", "void", "string", &VSquirrel::SHARED::KickPlayerByName);
|
|
Script_RegisterFunction(s, "KickPlayerById", "Script_KickPlayerById", "Kicks a player from the server by handle or nucleus id", "void", "string", &VSquirrel::SHARED::KickPlayerById);
|
|
|
|
Script_RegisterFunction(s, "BanPlayerByName", "Script_BanPlayerByName", "Bans a player from the server by name", "void", "string", &VSquirrel::SHARED::BanPlayerByName);
|
|
Script_RegisterFunction(s, "BanPlayerById", "Script_BanPlayerById", "Bans a player from the server by handle or nucleus id", "void", "string", &VSquirrel::SHARED::BanPlayerById);
|
|
|
|
Script_RegisterFunction(s, "UnbanPlayer", "Script_UnbanPlayer", "Unbans a player from the server by nucleus id or ip address", "void", "string", &VSquirrel::SHARED::UnbanPlayer);
|
|
|
|
Script_RegisterFunction(s, "ShutdownHostGame", "Script_ShutdownHostGame", "Shuts the local host game down", "void", "", &VSquirrel::SHARED::ShutdownHostGame);
|
|
}
|
|
#endif // !CLIENT_DLL
|
|
|
|
#ifndef DEDICATED
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: registers script functions in CLIENT context
|
|
// Input : *s -
|
|
//---------------------------------------------------------------------------------
|
|
void Script_RegisterClientFunctions(CSquirrelVM* s)
|
|
{
|
|
Script_RegisterFunction(s, "SDKNativeTest", "Script_SDKNativeTest", "Native CLIENT test function", "void", "", &VSquirrel::SHARED::SDKNativeTest);
|
|
Script_RegisterFunction(s, "GetSDKVersion", "Script_GetSDKVersion", "Gets the SDK version as a string", "string", "", &VSquirrel::SHARED::GetSDKVersion);
|
|
|
|
Script_RegisterFunction(s, "GetAvailableMaps", "Script_GetAvailableMaps", "Gets an array of all available maps", "array< string >", "", &VSquirrel::SHARED::GetAvailableMaps);
|
|
Script_RegisterFunction(s, "GetAvailablePlaylists", "Script_GetAvailablePlaylists", "Gets an array of all available playlists", "array< string >", "", &VSquirrel::SHARED::GetAvailablePlaylists);
|
|
|
|
Script_RegisterFunction(s, "ShutdownHostGame", "Script_ShutdownHostGame", "Shuts the local host game down", "void", "", &VSquirrel::SHARED::ShutdownHostGame);
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: registers script functions in UI context
|
|
// Input : *s -
|
|
//---------------------------------------------------------------------------------
|
|
void Script_RegisterUIFunctions(CSquirrelVM* s)
|
|
{
|
|
Script_RegisterFunction(s, "SDKNativeTest", "Script_SDKNativeTest", "Native UI test function", "void", "", &VSquirrel::SHARED::SDKNativeTest);
|
|
Script_RegisterFunction(s, "GetSDKVersion", "Script_GetSDKVersion", "Gets the SDK version as a string", "string", "", &VSquirrel::SHARED::GetSDKVersion);
|
|
|
|
Script_RegisterFunction(s, "RefreshServerList", "Script_RefreshServerList", "Refreshes the public server list and returns the count", "int", "", &VSquirrel::UI::RefreshServerCount);
|
|
|
|
// Functions for retrieving server browser data
|
|
Script_RegisterFunction(s, "GetServerName", "Script_GetServerName", "Gets the name of the server at the specified index of the server list", "string", "int", &VSquirrel::UI::GetServerName);
|
|
Script_RegisterFunction(s, "GetServerDescription", "Script_GetServerDescription", "Gets the description of the server at the specified index of the server list", "string", "int", &VSquirrel::UI::GetServerDescription);
|
|
Script_RegisterFunction(s, "GetServerMap", "Script_GetServerMap", "Gets the map of the server at the specified index of the server list", "string", "int", &VSquirrel::UI::GetServerMap);
|
|
Script_RegisterFunction(s, "GetServerPlaylist", "Script_GetServerPlaylist", "Gets the playlist of the server at the specified index of the server list", "string", "int", &VSquirrel::UI::GetServerPlaylist);
|
|
Script_RegisterFunction(s, "GetServerCurrentPlayers", "Script_GetServerCurrentPlayers", "Gets the current player count of the server at the specified index of the server list", "int", "int", &VSquirrel::UI::GetServerCurrentPlayers);
|
|
Script_RegisterFunction(s, "GetServerMaxPlayers", "Script_GetServerMaxPlayers", "Gets the max player count of the server at the specified index of the server list", "int", "int", &VSquirrel::UI::GetServerMaxPlayers);
|
|
Script_RegisterFunction(s, "GetServerCount", "Script_GetServerCount", "Gets the number of public servers", "int", "", &VSquirrel::UI::GetServerCount);
|
|
|
|
// Misc main menu functions
|
|
Script_RegisterFunction(s, "GetPromoData", "Script_GetPromoData", "Gets promo data for specified slot type", "string", "int", &VSquirrel::UI::GetPromoData);
|
|
|
|
// Functions for connecting to servers
|
|
Script_RegisterFunction(s, "CreateServer", "Script_CreateServer", "Start server with the specified settings", "void", "string, string, string, string, int", &VSquirrel::UI::CreateServer);
|
|
Script_RegisterFunction(s, "ConnectToServer", "Script_ConnectToServer", "Joins server by ip address and encryption key", "void", "string, string", &VSquirrel::UI::ConnectToServer);
|
|
Script_RegisterFunction(s, "ConnectToListedServer", "Script_ConnectToListedServer", "Joins listed server by index", "void", "int", &VSquirrel::UI::ConnectToListedServer);
|
|
Script_RegisterFunction(s, "ConnectToHiddenServer", "Script_ConnectToHiddenServer", "Joins hidden server by token", "void", "string", &VSquirrel::UI::ConnectToHiddenServer);
|
|
Script_RegisterFunction(s, "GetHiddenServerConnectStatus", "Script_GetHiddenServerConnectStatus", "Gets hidden server join status message", "string", "string", &VSquirrel::UI::GetHiddenServerConnectStatus);
|
|
|
|
Script_RegisterFunction(s, "GetAvailableMaps", "Script_GetAvailableMaps", "Gets an array of all available maps", "array< string >", "", &VSquirrel::SHARED::GetAvailableMaps);
|
|
Script_RegisterFunction(s, "GetAvailablePlaylists", "Script_GetAvailablePlaylists", "Gets an array of all available playlists", "array< string >", "", &VSquirrel::SHARED::GetAvailablePlaylists);
|
|
#ifndef CLIENT_DLL
|
|
Script_RegisterFunction(s, "KickPlayerByName", "Script_KickPlayerByName", "Kicks a player from the server by name", "void", "string", &VSquirrel::SHARED::KickPlayerByName);
|
|
Script_RegisterFunction(s, "KickPlayerById", "Script_KickPlayerById", "Kicks a player from the server by handle or nucleus id", "void", "string", &VSquirrel::SHARED::KickPlayerById);
|
|
|
|
Script_RegisterFunction(s, "BanPlayerByName", "Script_BanPlayerByName", "Bans a player from the server by name", "void", "string", &VSquirrel::SHARED::BanPlayerByName);
|
|
Script_RegisterFunction(s, "BanPlayerById", "Script_BanPlayerById", "Bans a player from the server by handle or nucleus id", "void", "string", &VSquirrel::SHARED::BanPlayerById);
|
|
|
|
Script_RegisterFunction(s, "UnbanPlayer", "Script_UnbanPlayer", "Unbans a player from the server by nucleus id or ip address", "void", "string", &VSquirrel::SHARED::UnbanPlayer);
|
|
#endif // !CLIENT_DLL
|
|
Script_RegisterFunction(s, "ShutdownHostGame", "Script_ShutdownHostGame", "Shuts the local host game down", "void", "", &VSquirrel::SHARED::ShutdownHostGame);
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: Initialize all CLIENT/UI global structs and register SDK (CLIENT/UI) script functions
|
|
// Input : *v -
|
|
// context - (1 = CLIENT 2 = UI)
|
|
//---------------------------------------------------------------------------------
|
|
SQRESULT Script_InitializeCLGlobalStructs(HSQUIRRELVM v, SQCONTEXT context)
|
|
{
|
|
SQRESULT results = v_Script_InitializeCLGlobalStructs(v, context);
|
|
|
|
if (context == SQCONTEXT::CLIENT)
|
|
Script_RegisterClientFunctions(g_pClientScript.GetValue<CSquirrelVM*>());
|
|
if (context == SQCONTEXT::UI)
|
|
Script_RegisterUIFunctions(g_pUIScript.GetValue<CSquirrelVM*>());
|
|
return results;
|
|
}
|
|
#endif // !DEDICATED
|
|
|
|
#ifndef CLIENT_DLL
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: Initialize all SERVER global structs and register SDK (SERVER) script functions
|
|
// Input : *v -
|
|
//---------------------------------------------------------------------------------
|
|
void Script_InitializeSVGlobalStructs(HSQUIRRELVM v)
|
|
{
|
|
v_Script_InitializeSVGlobalStructs(v);
|
|
Script_RegisterServerFunctions(Script_GetScriptHandle(SQCONTEXT::SERVER));
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: Creates the SERVER Squirrel VM
|
|
// Output : True on success, false on failure
|
|
//---------------------------------------------------------------------------------
|
|
SQBool Script_CreateServerVM()
|
|
{
|
|
SQBool results = v_Script_CreateServerVM();
|
|
if (results)
|
|
DevMsg(eDLL_T::SERVER, "Created SERVER VM: '0x%p'\n", Script_GetScriptHandle(SQCONTEXT::SERVER));
|
|
else
|
|
Error(eDLL_T::SERVER, EXIT_FAILURE, "Failed to create SERVER VM\n");
|
|
return results;
|
|
}
|
|
#endif // !CLIENT_DLL
|
|
|
|
#ifndef DEDICATED
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: Creates the CLIENT Squirrel VM
|
|
// Input : *hlClient -
|
|
// Output : True on success, false on failure
|
|
//---------------------------------------------------------------------------------
|
|
SQBool Script_CreateClientVM(CHLClient* hlclient)
|
|
{
|
|
SQBool results = v_Script_CreateClientVM(hlclient);
|
|
if (results)
|
|
DevMsg(eDLL_T::CLIENT, "Created CLIENT VM: '0x%p'\n", Script_GetScriptHandle(SQCONTEXT::CLIENT));
|
|
else
|
|
Error(eDLL_T::CLIENT, EXIT_FAILURE, "Failed to create CLIENT VM\n");
|
|
return results;
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: Creates the UI Squirrel VM
|
|
// Output : True on success, false on failure
|
|
//---------------------------------------------------------------------------------
|
|
SQBool Script_CreateUIVM()
|
|
{
|
|
SQBool results = v_Script_CreateUIVM();
|
|
if (results)
|
|
DevMsg(eDLL_T::UI, "Created UI VM: '0x%p'\n", Script_GetScriptHandle(SQCONTEXT::UI));
|
|
else
|
|
Error(eDLL_T::UI, EXIT_FAILURE, "Failed to create UI VM\n");
|
|
return results;
|
|
}
|
|
#endif // !DEDICATED
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: Returns the script VM pointer by context
|
|
// Input : context -
|
|
// Output : SQVM*
|
|
//---------------------------------------------------------------------------------
|
|
CSquirrelVM* Script_GetScriptHandle(const SQCONTEXT context)
|
|
{
|
|
switch (context)
|
|
{
|
|
#ifndef CLIENT_DLL
|
|
case SQCONTEXT::SERVER:
|
|
return g_pServerScript.GetValue<CSquirrelVM*>();
|
|
#endif // !CLIENT_DLL
|
|
#ifndef DEDICATED
|
|
case SQCONTEXT::CLIENT:
|
|
return g_pClientScript.GetValue<CSquirrelVM*>();
|
|
case SQCONTEXT::UI:
|
|
return g_pUIScript.GetValue<CSquirrelVM*>();
|
|
#endif // !DEDICATED
|
|
default:
|
|
return nullptr;
|
|
}
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: destroys the signal entry list head
|
|
// Input : *s -
|
|
// v -
|
|
// f -
|
|
// Output : true on success, false otherwise
|
|
//---------------------------------------------------------------------------------
|
|
SQBool Script_DestroySignalEntryListHead(CSquirrelVM* s, HSQUIRRELVM v, SQFloat f)
|
|
{
|
|
SQBool result = v_Script_DestroySignalEntryListHead(s, v, f);
|
|
Script_RegisterConstant(s, "DEVELOPER", developer->GetInt());
|
|
return result;
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: prints the global include file the compiler loads for loading scripts
|
|
// Input : *szRsonName -
|
|
//---------------------------------------------------------------------------------
|
|
SQInteger Script_LoadRson(const SQChar* rsonfile)
|
|
{
|
|
if (sq_showrsonloading->GetBool())
|
|
{
|
|
DevMsg(eDLL_T::ENGINE, "Loading RSON: '%s'\n", rsonfile);
|
|
}
|
|
return v_Script_LoadRson(rsonfile);
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: prints the scripts the compiler loads from global include to be compiled
|
|
// Input : *v -
|
|
// *path -
|
|
// *name -
|
|
// flags -
|
|
//---------------------------------------------------------------------------------
|
|
SQBool Script_LoadScript(HSQUIRRELVM v, const SQChar* path, const SQChar* name, SQInteger flags)
|
|
{
|
|
if (sq_showscriptloading->GetBool())
|
|
{
|
|
DevMsg(eDLL_T::ENGINE, "Loading script: '%s'\n", name);
|
|
}
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
return v_Script_LoadScript(v, path, name, flags);
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
// Purpose: Compiles and executes input code on target VM by context
|
|
// Input : *code -
|
|
// context -
|
|
//---------------------------------------------------------------------------------
|
|
void Script_Execute(const SQChar* code, const SQCONTEXT context)
|
|
{
|
|
if (!ThreadInMainThread())
|
|
{
|
|
const string scode(code);
|
|
g_TaskScheduler->Dispatch([scode, context]()
|
|
{
|
|
Script_Execute(scode.c_str(), context);
|
|
}, 0);
|
|
|
|
return; // Only run in main thread.
|
|
}
|
|
|
|
CSquirrelVM* s = Script_GetScriptHandle(context);
|
|
if (!s)
|
|
{
|
|
Error(eDLL_T::ENGINE, NO_ERROR, "Attempted to run %s script with no handle to VM\n", SQVM_GetContextName(context));
|
|
return;
|
|
}
|
|
|
|
HSQUIRRELVM v = s->GetVM();
|
|
if (!v)
|
|
{
|
|
Error(eDLL_T::ENGINE, NO_ERROR, "Attempted to run %s script while VM isn't initialized\n", SQVM_GetContextName(context));
|
|
return;
|
|
}
|
|
|
|
SQBufState bufState = SQBufState(code);
|
|
SQRESULT compileResult = sq_compilebuffer(v, &bufState, "console", -1);
|
|
|
|
if (compileResult >= NULL)
|
|
{
|
|
sq_pushroottable(v);
|
|
SQRESULT callResult = sq_call(v, 1, false, false);
|
|
}
|
|
}
|
|
|
|
//---------------------------------------------------------------------------------
|
|
void VSquirrelVM::Attach() const
|
|
{
|
|
DetourAttach((LPVOID*)&v_Script_RegisterConstant, &Script_RegisterConstant);
|
|
#ifndef DEDICATED
|
|
DetourAttach((LPVOID*)&v_Script_InitializeCLGlobalStructs, &Script_InitializeCLGlobalStructs);
|
|
#endif // !DEDICATED
|
|
#ifndef CLIENT_DLL
|
|
DetourAttach((LPVOID*)&v_Script_InitializeSVGlobalStructs, &Script_InitializeSVGlobalStructs);
|
|
DetourAttach((LPVOID*)&v_Script_CreateServerVM, &Script_CreateServerVM);
|
|
#endif // !CLIENT_DLL
|
|
#ifndef DEDICATED
|
|
DetourAttach((LPVOID*)&v_Script_CreateClientVM, &Script_CreateClientVM);
|
|
DetourAttach((LPVOID*)&v_Script_CreateUIVM, &Script_CreateUIVM);
|
|
#endif // !DEDICATED
|
|
DetourAttach((LPVOID*)&v_Script_DestroySignalEntryListHead, &Script_DestroySignalEntryListHead);
|
|
DetourAttach((LPVOID*)&v_Script_LoadRson, &Script_LoadRson);
|
|
DetourAttach((LPVOID*)&v_Script_LoadScript, &Script_LoadScript);
|
|
}
|
|
//---------------------------------------------------------------------------------
|
|
void VSquirrelVM::Detach() const
|
|
{
|
|
DetourDetach((LPVOID*)&v_Script_RegisterConstant, &Script_RegisterConstant);
|
|
#ifndef DEDICATED
|
|
DetourDetach((LPVOID*)&v_Script_InitializeCLGlobalStructs, &Script_InitializeCLGlobalStructs);
|
|
#endif // !DEDICATED
|
|
#ifndef CLIENT_DLL
|
|
DetourDetach((LPVOID*)&v_Script_InitializeSVGlobalStructs, &Script_InitializeSVGlobalStructs);
|
|
DetourDetach((LPVOID*)&v_Script_CreateServerVM, &Script_CreateServerVM);
|
|
#endif // !CLIENT_DLL
|
|
#ifndef DEDICATED
|
|
DetourDetach((LPVOID*)&v_Script_CreateClientVM, &Script_CreateClientVM);
|
|
DetourDetach((LPVOID*)&v_Script_CreateUIVM, &Script_CreateUIVM);
|
|
#endif // !DEDICATED
|
|
DetourDetach((LPVOID*)&v_Script_DestroySignalEntryListHead, &Script_DestroySignalEntryListHead);
|
|
DetourDetach((LPVOID*)&v_Script_LoadRson, &Script_LoadRson);
|
|
DetourDetach((LPVOID*)&v_Script_LoadScript, &Script_LoadScript);
|
|
}
|