feat(scripting/entities): Entity Custom Classname

Author: skuzzis

docgen/data/data.json

@@ -367,8 +367,13 @@
 					"cpp": "entities->Create"
 				},
 				"return": "Entity*",
-				"params": {},
-				"additional": {}
+				"params": {
+					"classname": "const char*"
+				},
+				"additional": {
+					"lua": ":::note\nA list of the entity class names can be found here: [https://cs2.poggu.me/dumped-data/entity-list](https://cs2.poggu.me/dumped-data/entity-list).\nAs a class name it can also be used the following class name format to select a player: \"player:PLAYERID\", where PLAYERID is the player id.\n:::",
+					"cpp": ":::note\nA list of the entity class names can be found here: [https://cs2.poggu.me/dumped-data/entity-list](https://cs2.poggu.me/dumped-data/entity-list).\nAs a class name it can also be used the following class name format to select a player: \"player:PLAYERID\", where PLAYERID is the player id.\n:::"
+				}
 			},
 			"entity": {
 				"title": "Entity",

plugin_files/scripting/includes/swiftly/entities.cpp

@@ -1,8 +1,8 @@
 #include "entities.h"
 
-Entity *Entities::Create()
+Entity *Entities::Create(const char *clsname)
 {
-    Entity *entity = new Entity();
+    Entity *entity = new Entity(clsname);
     this->entities.insert(std::make_pair(entity->GetEntityID(), entity));
     return entity;
 }

plugin_files/scripting/includes/swiftly/entities.h

@@ -14,7 +14,7 @@ class Entities
 public:
     Entities(){};
 
-    Entity *Create();
+    Entity *Create(const char *clsname = nullptr);
     Entity *Fetch(uint32_t id);
     void Destroy(uint32_t id);
 

plugin_files/scripting/includes/swiftly/entities/entity.cpp

@@ -1,17 +1,17 @@
 #include "entity.h"
 #include "../swiftly.h"
 
-typedef uint32_t (*CreateEntity)();
+typedef uint32_t (*CreateEntity)(const char *);
 typedef void (*Entity_Spawn)(uint32_t);
 typedef void (*Entity_Destroy)(uint32_t);
 typedef void (*Entity_SetModel)(uint32_t, const char *);
 typedef void (*Entity_AcceptInput)(uint32_t, const char *, const char *, const char *, double *);
 
-Entity::Entity()
+Entity::Entity(const char *clsname)
 {
     void *createEntity = FetchFunctionPtr(nullptr, "scripting_Entity_Create");
     if (createEntity)
-        this->entityID = reinterpret_cast<CreateEntity>(createEntity)();
+        this->entityID = reinterpret_cast<CreateEntity>(createEntity)(clsname);
     else
         NOT_SUPPORTED("scripting_Entity_Create");
 

plugin_files/scripting/includes/swiftly/entities/entity.h

@@ -19,7 +19,7 @@ class Entity
     Angles *angles;
     Colors *color;
 
-    Entity();
+    Entity(const char *clsname = nullptr);
     ~Entity();
 
     void Spawn();

src/components/Plugins/inc/Scripting.h

@@ -44,7 +44,7 @@ SMM_API const char *scripting_Database_EscapeString(const char *connectionName,
 std::vector<std::map<const char *, std::any>> scripting_Database_QueryRaw(const char *connectionName, const char *query);
 SMM_API const char *scripting_Database_Query(const char *connectionName, const char *query);
 
-SMM_API uint32_t scripting_Entity_Create();
+SMM_API uint32_t scripting_Entity_Create(const char *classname);
 SMM_API void scripting_Entity_Spawn(uint32_t entityID);
 SMM_API void scripting_Entity_Destroy(uint32_t entityID);
 SMM_API void scripting_Entity_SetModel(uint32_t entityID, const char *model);

src/components/Plugins/src/language/lua/entities.cpp

@@ -18,9 +18,9 @@ class LuaEntityClass
     uint32_t entityID = 0;
 
 public:
-    LuaEntityClass()
+    LuaEntityClass(const char *clsname)
     {
-        this->entityID = scripting_Entity_Create();
+        this->entityID = scripting_Entity_Create(clsname);
     }
 
     uint32_t GetEntityID()
@@ -37,9 +37,9 @@ class LuaEntitiesClass
 public:
     LuaEntitiesClass() {}
 
-    luacpp::LuaObject CreateEntity(luacpp::LuaClass<LuaEntityClass> entityClass)
+    luacpp::LuaObject CreateEntity(luacpp::LuaClass<LuaEntityClass> entityClass, const char *clsname)
     {
-        luacpp::LuaObject entityObject = entityClass.CreateInstance();
+        luacpp::LuaObject entityObject = entityClass.CreateInstance(clsname);
         LuaEntityClass *entity = static_cast<LuaEntityClass *>(entityObject.ToPointer());
 
         this->entities.insert(std::make_pair(entity->GetEntityID(), entityObject));
@@ -86,14 +86,14 @@ class LuaEntityArgsClass
 void SetupLuaEntities(luacpp::LuaState *state, Plugin *plugin)
 {
     auto entitiesClass = state->CreateClass<LuaEntitiesClass>("Entities").DefConstructor();
-    auto entityClass = state->CreateClass<LuaEntityClass>().DefConstructor();
+    auto entityClass = state->CreateClass<LuaEntityClass>().DefConstructor<const char *>();
 
     auto coordsClass = state->CreateClass<LuaEntityArgsClass>().DefConstructor<uint32_t>();
     auto anglesClass = state->CreateClass<LuaEntityArgsClass>().DefConstructor<uint32_t>();
     auto colorsClass = state->CreateClass<LuaEntityArgsClass>().DefConstructor<uint32_t>();
 
-    entitiesClass.DefMember("Create", [entityClass](LuaEntitiesClass *base) -> luacpp::LuaObject
-                            { return base->CreateEntity(entityClass); })
+    entitiesClass.DefMember("Create", [entityClass](LuaEntitiesClass *base, luacpp::LuaObject clsObj) -> luacpp::LuaObject
+                            { return base->CreateEntity(entityClass, clsObj.GetType() != LUA_TSTRING ? nullptr : clsObj.ToString()); })
         .DefMember("Destroy", [](LuaEntitiesClass *base, int entityid) -> void
                    { base->DestroyEntity(entityid); })
         .DefMember("Fetch", [state](LuaEntitiesClass *base, int entityID) -> luacpp::LuaObject

src/components/Plugins/src/scripting/Entity.cpp

@@ -48,15 +48,19 @@ CEntityInstance *FetchInstanceByInput(std::string input)
         if (player == nullptr)
             return nullptr;
 
-        return player->GetPlayerController();
+        return player->GetPlayerPawn();
     }
     else
         return nullptr;
 }
 
-SMM_API uint32_t scripting_Entity_Create()
+SMM_API uint32_t scripting_Entity_Create(const char *classname)
 {
-    uint32_t entityID = g_entityManager->CreateEntity();
+    std::string clsname = classname;
+    if (classname == nullptr)
+        clsname = "prop_dynamic_override";
+
+    uint32_t entityID = g_entityManager->CreateEntity(classname);
     return entityID;
 }
 

src/entities/Entity.cpp

@@ -3,10 +3,27 @@
 #include <thread>
 
 typedef void *(*UTIL_CreateEntityByName)(const char *, int);
+CEntityInstance *FetchInstanceByInput(std::string input);
 
-Entity::Entity()
+Entity::Entity(std::string classname)
 {
-    this->worldEntity = reinterpret_cast<CBaseModelEntity *>(g_Signatures->FetchSignature<UTIL_CreateEntityByName>("UTIL_CreateEntityByName")("prop_dynamic_override", -1));
+    CEntityInstance *instance = FetchInstanceByInput(classname);
+    if (starts_with(classname, "player:"))
+    {
+        this->worldEntity = reinterpret_cast<CBaseModelEntity *>(instance);
+        this->player = true;
+        this->spawned = true;
+    }
+    else if (starts_with(classname, "entity:"))
+    {
+        this->worldEntity = nullptr;
+        PRINTF("Entity::Entity", "You can't create an entity from another entity.\n");
+    }
+    else
+    {
+        this->worldEntity = reinterpret_cast<CBaseModelEntity *>(g_Signatures->FetchSignature<UTIL_CreateEntityByName>("UTIL_CreateEntityByName")(classname.c_str(), -1));
+    }
+
     if (this->worldEntity == nullptr)
         PRINTF("Entity::Entity", "Failed to create entity.\n");
 }
@@ -41,6 +58,9 @@ void Entity::SetAngle(float x, float y, float z)
 
 void Entity::SetSolidType(SolidType_t solid_type)
 {
+    if (this->player)
+        return;
+
     this->worldEntity->m_Collision.Get().m_nSolidType = solid_type;
 }
 

src/entities/Entity.h

@@ -13,9 +13,10 @@ class Entity
     Z_CBaseEntity *entity = nullptr;
     std::string model;
     bool spawned = false;
+    bool player = false;
 
 public:
-    Entity();
+    Entity(std::string classname);
     Entity(CEntityInstance *entityInstance);
 
     Vector GetCoords();