Initial commit

gamemodes/darkrp/gamemode/modules/police/sh_interface.lua

@@ -0,0 +1,231 @@
+DarkRP.PLAYER.isWanted = DarkRP.stub{
+    name = "isWanted",
+    description = "Whether this player is wanted",
+    parameters = {
+    },
+    returns = {
+        {
+            name = "answer",
+            description = "Whether this player is wanted",
+            type = "boolean"
+        }
+    },
+    metatable = DarkRP.PLAYER
+}
+
+DarkRP.PLAYER.getWantedReason = DarkRP.stub{
+    name = "getWantedReason",
+    description = "Get the reason why someone is wanted",
+    parameters = {
+    },
+    returns = {
+        {
+            name = "answer",
+            description = "The reason",
+            type = "string"
+        }
+    },
+    metatable = DarkRP.PLAYER
+}
+
+DarkRP.PLAYER.isArrested = DarkRP.stub{
+    name = "isArrested",
+    description = "Whether this player is arrested",
+    parameters = {
+    },
+    returns = {
+        {
+            name = "answer",
+            description = "Whether this player is arrested",
+            type = "boolean"
+        }
+    },
+    metatable = DarkRP.PLAYER
+}
+
+DarkRP.PLAYER.isCP = DarkRP.stub{
+    name = "isCP",
+    description = "Whether this player is part of the police force (mayor, cp, chief).",
+    parameters = {
+    },
+    returns = {
+        {
+            name = "answer",
+            description = "Whether this player is part of the police force.",
+            type = "boolean"
+        }
+    },
+    metatable = DarkRP.PLAYER
+}
+
+DarkRP.PLAYER.isMayor = DarkRP.stub{
+    name = "isMayor",
+    description = "Whether this player is a mayor.",
+    parameters = {
+    },
+    returns = {
+        {
+            name = "answer",
+            description = "Whether this player is a mayor.",
+            type = "boolean"
+        }
+    },
+    metatable = DarkRP.PLAYER
+}
+
+DarkRP.PLAYER.isChief = DarkRP.stub{
+    name = "isChief",
+    description = "Whether this player is a Chief.",
+    parameters = {
+    },
+    returns = {
+        {
+            name = "answer",
+            description = "Whether this player is a Chief.",
+            type = "boolean"
+        }
+    },
+    metatable = DarkRP.PLAYER
+}
+
+
+DarkRP.hookStub{
+    name = "canRequestWarrant",
+    description = "Whether someone can request a search warrant.",
+    parameters = {
+        {
+            name = "target",
+            description = "The player to get the search warrant for",
+            type = "Player"
+        },
+        {
+            name = "actor",
+            description = "The player requesting the warrant",
+            type = "Player"
+        },
+        {
+            name = "reason",
+            description = "The reason for the search warrant",
+            type = "Player"
+        }
+    },
+    returns = {
+        {
+            name = "canRequest",
+            description = "A yes or no as to whether the search warrant can be requested",
+            type = "boolean"
+        },
+        {
+            name = "message",
+            description = "The message that is shown when it can't",
+            type = "string"
+        }
+    }
+}
+
+DarkRP.hookStub{
+    name = "canWanted",
+    description = "Whether someone can make a player wanted",
+    parameters = {
+        {
+            name = "target",
+            description = "The player to make wanted by the police",
+            type = "Player"
+        },
+        {
+            name = "actor",
+            description = "The player requesting the wanted status",
+            type = "Player"
+        },
+        {
+            name = "reason",
+            description = "The reason",
+            type = "Player"
+        }
+    },
+    returns = {
+        {
+            name = "canRequest",
+            description = "A yes or no as to whether the wanted can be requested",
+            type = "boolean"
+        },
+        {
+            name = "message",
+            description = "The message that is shown when it can't",
+            type = "string"
+        }
+    }
+}
+
+DarkRP.hookStub{
+    name = "canUnwant",
+    description = "Whether someone can remove the wanted status from a player",
+    parameters = {
+        {
+            name = "target",
+            description = "The player to make wanted by the police",
+            type = "Player"
+        },
+        {
+            name = "actor",
+            description = "The player requesting the wanted status",
+            type = "Player"
+        }
+    },
+    returns = {
+        {
+            name = "canUnwant",
+            description = "A yes or no answer",
+            type = "boolean"
+        },
+        {
+            name = "message",
+            description = "The message that is shown when the answer is no",
+            type = "string"
+        }
+    }
+}
+
+DarkRP.hookStub{
+    name = "lockdownStarted",
+    description = "When a lockdown has started.",
+    parameters = {
+        {
+            name = "actor",
+            description = "The player who started the lockdown. Note: Can be the world entitity.",
+            type = "Player"
+        }
+    },
+    returns = {}
+}
+
+DarkRP.hookStub{
+    name = "lockdownEnded",
+    description = "When a lockdown has ended.",
+    parameters = {
+        {
+            name = "actor",
+            description = "The player who ended the lockdown. Note: Can be the world entitity.",
+            type = "Player"
+        }
+    },
+    returns = {}
+}
+
+DarkRP.hookStub{
+    name = "playerGotLicense",
+    description = "When a player got a gun license",
+    parameters = {
+        {
+            name = "target",
+            description = "The player who got the license",
+            type = "Player"
+        },
+        {
+            name = "actor",
+            description = "The player who gave the license",
+            type = "Player"
+        }
+    },
+    returns = {}
+}