Added basic class API: ZR_IsValidClassIndex, ZR_GetActiveClass, ZR_SelectClientClass, ZR_GetClassByName, ZR_GetClassDisplayName

src/zr/api/api.inc

@@ -43,6 +43,7 @@
 
 #include "zr/api/infect.api"
 #include "zr/api/respawn.api"
+#include "zr/api/class.api"
 
 /**
  * Initializes all main natives and forwards.
@@ -52,6 +53,7 @@ APIInit()
     // Forward event to sub-modules.
     APIInfectInit();
     APIRespawnInit();
+    APIClassInit();
 }
 
 /**
@@ -68,12 +70,14 @@ stock APIValidateClientIndex(client, EligibleCondition:alive = Condition_Either)
     if (client < 1 || client > MaxClients)
     {
         ThrowNativeError(SP_ERROR_NATIVE, "Invalid client index. (%d)", client);
+        return;
     }
     
     // Verify that the client is connected.
     if (!IsClientConnected(client))
     {
         ThrowNativeError(SP_ERROR_NATIVE, "Client %d is not connected.", client);
+        return;
     }
     
     // Check if the player must be dead or alive.

src/zr/api/class.api.inc

@@ -0,0 +1,167 @@
+/*
+ * ============================================================================
+ *
+ *  Zombie:Reloaded
+ *
+ *  File:          class.api.inc
+ *  Type:          Core
+ *  Description:   Native handlers for the ZR API. (Class module)
+ *
+ *  Copyright (C) 2009-2012  Greyscale, Richard Helgeby
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * ============================================================================
+ */
+
+/**
+ * Initializes all natives and forwards related to infection.
+ */
+APIClassInit()
+{
+    // Class module natives/forwards (class.zr.inc)
+    
+    // Natives
+    CreateNative("ZR_IsValidClassIndex", APIIsValidClassIndex);
+    CreateNative("ZR_GetActiveClass", APIGetActiveClass);
+    CreateNative("ZR_SelectClientClass", APISelectClientClass);
+    CreateNative("ZR_GetClassByName", APIGetClassByName);
+    CreateNative("ZR_GetClassDisplayName", APIGetClassDisplayName);
+}
+
+/**
+ * Native call function (ZR_IsValidClassIndex)
+ *
+ * bool:ZR_IsValidClassIndex(classIndex);
+ */
+public APIIsValidClassIndex(Handle:plugin, numParams)
+{
+    new classIndex = GetNativeCell(1);
+    
+    return ClassValidateIndex(classIndex);
+}
+
+/**
+ * Native call function (ZR_GetActiveClass)
+ *
+ * native bool:ZR_GetActiveClass(client);
+ */
+public APIGetActiveClass(Handle:plugin, numParams)
+{
+    new client = GetNativeCell(1);
+    
+    // Validate the client index. Player must be alive.
+    APIValidateClientIndex(client, Condition_True);
+    
+    return ClassGetActiveIndex(client);
+}
+
+/**
+ * Native call function (ZR_SelectClientClass)
+ *
+ * native ClassSelectResult:ZR_SelectClientClass(client, classIndex, bool:applyIfPossible = true, bool:saveIfEnabled = true)
+ */
+public APISelectClientClass(Handle:plugin, numParams)
+{
+    new client = GetNativeCell(1);
+    new classIndex = GetNativeCell(2);
+    new bool:applyIfPossible = bool:GetNativeCell(3);
+    new bool:saveIfEnabled = bool:GetNativeCell(4);
+    
+    // Validate the client index.
+    APIValidateClientIndex(client, Condition_Either);
+    
+    // Validate class index.
+    if (!ClassValidateIndex(classIndex))
+    {
+        ThrowNativeError(SP_ERROR_NATIVE, "Invalid class index. (%d)", classIndex);
+        return -1;
+    }
+    
+    return _:ClassSelectClientClass(client, classIndex, applyIfPossible, saveIfEnabled);
+}
+
+/**
+ * Native call function (ZR_GetClassByName)
+ *
+ * native ZR_GetClassByName(const String:className[], cacheType = ZR_CLASS_CACHE_MODIFIED);
+ */
+public APIGetClassByName(Handle:plugin, numParams)
+{
+    decl String:className[64];
+    className[0] = 0;
+    
+    // Get class name.
+    if (GetNativeString(1, className, sizeof(className)) != SP_ERROR_NONE)
+    {
+        ThrowNativeError(SP_ERROR_NATIVE, "Unexpected error when reading className parameter. Possibly corrupt or missing data.");
+        return -1;
+    }
+    
+    new cacheType = GetNativeCell(2);
+    if (cacheType == ZR_CLASS_CACHE_PLAYER)
+    {
+        ThrowNativeError(SP_ERROR_NATIVE, "Invalid cache type. Player cache is not allowed in this function.");
+        return -1;
+    }
+    
+    return ClassGetIndex(className, cacheType);
+}
+
+/**
+ * Native call function (ZR_GetClassDisplayName)
+ *
+ * native ZR_GetClassDisplayName(classIndex, String:buffer[], maxlen, cacheType = ZR_CLASS_CACHE_MODIFIED);
+ */
+public APIGetClassDisplayName(Handle:plugin, numParams)
+{
+    new index = GetNativeCell(1);
+    new maxlen = GetNativeCell(3);
+    new cacheType = GetNativeCell(4);
+    
+    if (maxlen <= 0)
+    {
+        // No buffer size.
+        return 0;
+    }
+    
+    // Validate index.
+    if (cacheType == ZR_CLASS_CACHE_PLAYER)
+    {
+        // Client index.
+        APIValidateClientIndex(index, Condition_Either);
+    }
+    else
+    {
+        // Class index.
+        if (!ClassValidateIndex(index))
+        {
+            ThrowNativeError(SP_ERROR_NATIVE, "Invalid class index. (%d)", index);
+            return 0;
+        }
+    }
+    
+    decl String:displayName[maxlen];
+    
+    new bytes = ClassGetName(index, displayName, maxlen, cacheType);
+    if (bytes <= 0)
+    {
+        // The class doesn't have a name for some reason. Make sure the buffer is empty.
+        displayName[0] = 0;
+    }
+    
+    SetNativeString(2, displayName, maxlen);
+    
+    return bytes;
+}