Skip to main content

Exports

setToWaypoint (Client-side)​

Cette fonction permet de téléporter le joueur vers un waypoint défini sur la carte.

Syntaxe​

exports["gw-admin"]:setToWaypoint()

Description​

La fonction setToWaypoint cherche un waypoint placé sur la carte et téléporte le joueur vers cet emplacement. Si aucun waypoint n'est défini, une notification est déclenchée pour informer le joueur.

Fonctionnement​

  1. Recherche du waypoint sur la carte.
  2. Vérification si le waypoint existe :
    • Si le waypoint existe, la fonction calcule les coordonnées du sol à l'emplacement et téléporte le joueur à cet endroit.
    • Si aucun waypoint n'est défini, une notification est affichée avec le message : "Aucun marqueur sur la carte".

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:setToWaypoint()

Lorsque cette exports est appelée, le joueur sera téléporté vers le waypoint actuellement défini sur la carte.

Voici la documentation pour la fonction setNoClip :

setNoClip (Client-side)​

Cette fonction active ou désactive le mode NoClip pour le joueur, permettant de traverser les objets et de se déplacer librement dans l'espace sans collision.

Syntaxe​

exports["gw-admin"]:setNoClip()

Description​

La fonction setNoClip utilise la méthode ToggleNoclip() pour activer ou désactiver le mode NoClip. Si le mode NoClip est déjà activé, il sera désactivé, et inversement.

Fonctionnement​

  1. Active ou désactive le mode NoClip pour le joueur.
  2. Le joueur peut se déplacer librement, sans être limité par les collisions ou la gravité.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:setNoClip()

Lorsque cette ligne est appelée, le mode NoClip est activé ou désactivé pour le joueur.

Voici la documentation pour la fonction setStaffMode :

setStaffMode (Client-side)​

Cette fonction active ou désactive le mode staff pour le joueur. Le mode staff est généralement utilisé pour octroyer des capacités ou des permissions spéciales aux membres du staff d'un serveur.

Syntaxe​

exports["gw-admin"]:setStaffMode()

Description​

La fonction setStaffMode bascule l'état du mode staff en fonction de l'état actuel du joueur. Si le mode staff est désactivé, il sera activé, et inversement. Des notifications sont affichées pour informer le joueur du changement d'état, et un événement est déclenché côté serveur pour informer le serveur du nouveau statut.

Fonctionnement​

  1. Inverse l'état du mode staff du joueur :
    • Si le mode staff est activé, un événement serveur (gunware:staffMode) est déclenché avec la valeur true.
    • Si le mode staff est désactivé, un événement serveur est déclenché avec la valeur false.
  2. Affiche une notification :
    • "Mode staff activé" si le mode staff est activé.
    • "Mode staff désactivé" si le mode staff est désactivé.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:setStaffMode()

Lorsque cette ligne est appelée, le mode staff sera activé ou désactivé pour le joueur, avec des notifications correspondantes.

Voici la documentation pour la fonction reportMenu :

reportMenu (Client-side)​

Cette fonction ouvre le menu de rapport (report menu) pour que le joueur puisse signaler un problème ou un joueur.

Syntaxe​

exports["gw-admin"]:reportMenu()

Description​

La fonction reportMenu appelle la méthode clientReportMenu(), qui affiche le menu de rapport sur l'interface du joueur. Ce menu permet au joueur d'envoyer des rapports, généralement pour signaler des incidents, bugs, ou comportements de joueurs.

Fonctionnement​

  1. Ouvre l'interface du menu de rapport pour le joueur.
  2. Le joueur peut interagir avec ce menu pour soumettre un rapport.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:reportMenu()

Lors de l'exécution de cette commande, le menu de rapport s'affichera pour le joueur afin qu'il puisse soumettre des informations.

createReportPlayer (Client-side)​

Cette fonction permet à un joueur de créer un rapport signalant un autre joueur et d'envoyer ce rapport au serveur pour traitement.

Syntaxe​

exports["gw-admin"]:createReportPlayer(message, target, targetPlayer)

Paramètres​

  • message (string) : Le contenu du rapport, décrivant la raison pour laquelle le rapport est envoyé.
  • target (int) : L'identifiant du joueur qui crée le rapport (l'auteur du rapport).
  • targetPlayer (int) : L'identifiant du joueur qui est signalé dans le rapport.

Description​

La fonction createReportPlayer formate un message de rapport contenant les informations du joueur qui crée le rapport (target) et du joueur qui est signalé (targetPlayer). Le message inclut le nom du joueur qui fait le rapport, le rôle-play (RP) du joueur signalé, ainsi que la raison du rapport.

Le message est formaté ainsi :

  • Auteur : Nom du joueur qui crée le rapport (récupéré via PlayerServer[target].name).
  • Joueur signalé : Nom de rôle-play du joueur signalé (récupéré via PlayerServer[targetPlayer].rp).
  • Raison : Le motif du rapport contenu dans le paramètre message.

Le rapport est ensuite envoyé via un événement serveur pour être traité.

Fonctionnement​

  1. Le message est formaté avec les informations suivantes :
    • Auteur : Nom du joueur qui fait le rapport.
    • Joueur signalé : Nom de RP du joueur signalé.
    • Raison : La raison du rapport.
  2. Le rapport est envoyé au serveur avec l'événement gunware:report, en passant le targetPlayer pour que le serveur sache quel joueur est concerné par le rapport.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:createReportPlayer("Violation des règles du serveur", 1, 2)

Dans cet exemple :

  • Le joueur avec l'identifiant 1 crée un rapport signalant le joueur avec l'identifiant 2 pour "Violation des règles du serveur".

createReport (Client-side)​

Cette fonction permet à un joueur de créer un rapport et de l'envoyer au serveur avec un message personnalisé.

Syntaxe​

exports["gw-admin"]:createReport(message, target)

Paramètres​

  • message (string) : Le contenu du rapport, décrivant la raison du rapport.
  • target (int) : L'identifiant du joueur qui crée le rapport (l'auteur du rapport).

Description​

La fonction createReport génère un rapport en incluant des informations sur le joueur qui soumet le rapport (target) ainsi que la raison du rapport. Le rapport est ensuite envoyé au serveur via l'événement gunware:report.

Le message du rapport est formaté comme suit :

  • Auteur : Le nom du joueur qui fait le rapport (PlayerServer[target].name).
  • Raison : La raison du rapport (fourni dans message).

Une fois le rapport généré, il est transmis au serveur pour traitement.

Fonctionnement​

  1. Le message du rapport est formaté avec les informations suivantes :
    • Auteur : Nom du joueur qui soumet le rapport.
    • Raison : La raison donnée pour le rapport (provenant de message).
  2. Le rapport est envoyé au serveur via l'événement gunware:report, sans spécifier de joueur signalé (le targetPlayer est ici défini à false).

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:createReport("Exploitation de bugs", 1)

Dans cet exemple :

  • Le joueur avec l'identifiant 1 crée un rapport pour une exploitation de bugs.

warnPlayer (Client-side)​

Cette fonction permet d'envoyer un avertissement à un joueur via un événement serveur, en spécifiant la raison de l'avertissement et la source de celui-ci.

Syntaxe​

exports["gw-admin"]:warnPlayer(target, reason, src)

Paramètres​

  • target (int) : L'identifiant du joueur qui doit recevoir l'avertissement.
  • reason (string) : La raison pour laquelle le joueur est averti.
  • src (int) : L'identifiant de la source (souvent celui du joueur ou admin qui émet l'avertissement).

Description​

La fonction warnPlayer permet d'envoyer un avertissement à un joueur en transmettant un message au serveur via l'événement gunware:sync:actionPlayer. Cette fonction est utilisée pour avertir un joueur d'une infraction ou d'un comportement inapproprié.

Le message envoyé au serveur inclut :

  • target : L'identifiant du joueur qui reçoit l'avertissement.
  • reason : La raison de l'avertissement.
  • src : L'identifiant de la personne (source) qui a émis l'avertissement.

Fonctionnement​

  1. La fonction déclenche un événement serveur (gunware:sync:actionPlayer) avec les informations suivantes :
    • target : Le joueur à avertir.
    • reason : La raison de l'avertissement.
    • src : La source de l'avertissement.
  2. Le serveur gère ensuite la synchronisation et les actions à prendre concernant l'avertissement du joueur.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:warnPlayer(2, "Comportement inapproprié", 1)

Dans cet exemple :

  • Le joueur avec l'identifiant 2 reçoit un avertissement pour "Comportement inapproprié", et la source de cet avertissement est le joueur avec l'identifiant 1.

Aveugler (Client-side)​

Cette fonction permet de rendre temporairement un joueur aveugle en envoyant un événement au serveur pour synchroniser l'action.

Syntaxe​

exports["gw-admin"]:Aveugler(target)

Paramètres​

  • target (int) : L'identifiant du joueur qui doit être aveuglé.

Description​

La fonction Aveugler envoie un événement au serveur pour rendre un joueur temporairement aveugle. Cela peut être utilisé comme mesure disciplinaire ou pour des scénarios spécifiques dans le jeu.

Le message envoyé au serveur inclut uniquement :

  • target : L'identifiant du joueur à aveugler.

L'événement gunware:sync:actionPlayer est déclenché pour synchroniser cette action avec le serveur.

Fonctionnement​

  1. La fonction déclenche un événement serveur (gunware:sync:actionPlayer) avec l'action "player_blind" et le joueur cible défini par l'identifiant target.

  2. Le serveur gère ensuite l'effet d'aveuglement sur le joueur concerné.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:Aveugler(2)

Dans cet exemple :

  • Le joueur avec l'identifiant 2 sera aveuglé.

Spectate (Client-side)​

Cette fonction permet à un joueur (souvent un administrateur) d'entrer en mode spectateur pour observer un autre joueur ciblé.

Syntaxe​

exports["gw-admin"]:Spectate(target, src)

Paramètres​

  • target (int) : L'identifiant du joueur à observer.
  • src (int) : L'identifiant de la source, généralement le joueur qui active le mode spectateur.

Description​

La fonction Spectate déclenche un événement serveur pour permettre à un administrateur ou un joueur autorisé de regarder un autre joueur en mode spectateur. L'événement envoie les informations nécessaires au serveur pour synchroniser le spectateur et le joueur ciblé.

Le message envoyé au serveur inclut :

  • target : L'identifiant du joueur à observer, obtenu via client.cache.playerSelected.source.
  • src : L'identifiant de la personne (souvent un administrateur) qui souhaite observer le joueur.

Fonctionnement​

  1. La fonction déclenche un événement serveur (gunware:sync:actionPlayer) avec l'action "player_spectate" et les identifiants du joueur à observer (target) ainsi que la source du spectateur (src).

  2. Le serveur synchronise ensuite cette action pour permettre au joueur de regarder l'autre en mode spectateur.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:Spectate(2, 1)

Dans cet exemple :

  • Le joueur avec l'identifiant 1 (la source) entre en mode spectateur pour observer le joueur avec l'identifiant 2.

Ban (Client-side)​

Cette fonction permet de bannir un joueur pour une durée déterminée, avec une raison spécifiée.

Syntaxe​

exports["gw-admin"]:Ban(target, time, reason)

Paramètres​

  • target (int) : L'identifiant du joueur à bannir.
  • time (int) : La durée du bannissement en minutes. Si time est égal à 0, le bannissement est permanent.
  • reason (string) : La raison du bannissement.

Description​

La fonction Ban déclenche un événement serveur pour bannir un joueur. L'événement envoie au serveur l'identifiant du joueur ciblé, la durée du bannissement, et la raison. Si le temps spécifié est 0, le bannissement sera permanent.

Le message envoyé au serveur inclut :

  • target : L'identifiant du joueur à bannir.
  • time : La durée du bannissement, en minutes.
  • reason : La raison du bannissement, qui sera enregistrée dans les logs du serveur.

Fonctionnement​

  1. La fonction déclenche un événement serveur (gunware:sync:actionPlayer) avec l'action "player_ban", envoyant les informations suivantes :
    • target : Le joueur à bannir.
    • time : Durée du bannissement.
    • reason : La raison du bannissement.
  2. Le serveur gère ensuite le bannissement du joueur pour la durée spécifiée, ou de façon permanente si time est égal à 0.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:Ban(2, 1440, "Triche")

Dans cet exemple :

  • Le joueur avec l'identifiant 2 est banni pour 1440 minutes (1 jour) pour cause de triche.
exports["gw-admin"]:Ban(3, 0, "Comportement inacceptable")

Dans cet exemple :

  • Le joueur avec l'identifiant 3 est banni de façon permanente pour comportement inacceptable.

Screenshot (Client-side)​

Cette fonction permet à un administrateur ou à un joueur autorisé de prendre une capture d'écran d'un autre joueur.

Syntaxe​

exports["gw-admin"]:Screenshot(target, src)

Paramètres​

  • target (int) : L'identifiant du joueur dont la capture d'écran doit être prise.
  • src (int) : L'identifiant de la source (souvent l'administrateur ou le joueur autorisé qui demande la capture).

Description​

La fonction Screenshot déclenche un événement serveur pour prendre une capture d'écran du joueur cible. Cet événement est utilisé pour surveiller les activités d'un joueur ou pour recueillir des preuves visuelles dans le cadre de la gestion du serveur.

Le message envoyé au serveur contient :

  • target : L'identifiant du joueur dont la capture d'écran sera prise.
  • src : L'identifiant de la personne qui demande la capture d'écran.

Fonctionnement​

  1. La fonction déclenche un événement serveur (gunware:sync:actionPlayer) avec l'action "player_screenshot", en envoyant les informations du joueur cible et de la source de la requête.

  2. Le serveur gère la demande et traite la capture d'écran du joueur ciblé.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:Screenshot(2, 1)

Dans cet exemple :

  • Le joueur avec l'identifiant 1 (souvent un administrateur) demande une capture d'écran du joueur avec l'identifiant 2.

player_me (Client-side)​

Cette fonction permet de jouer une action de type /me pour un joueur spécifique. Le /me est généralement utilisé pour décrire une action ou un état RP (RolePlay) visible par les autres joueurs à proximité.

Syntaxe​

exports["gw-admin"]:player_me(target, message)

Paramètres​

  • target (int) : L'identifiant du joueur pour qui l'action /me sera exécutée.
  • message (string) : Le message à afficher dans le cadre de l'action /me.

Description​

La fonction player_me permet de déclencher une action /me pour le joueur ciblé, en envoyant le message au serveur via un événement. Ce message est alors affiché aux autres joueurs à proximité pour décrire une action RP que le joueur effectue.

Le message envoyé au serveur contient :

  • target : L'identifiant du joueur pour qui l'action /me sera jouée.
  • message : Le texte qui sera affiché aux autres joueurs, décrivant l'action ou l'état du joueur.

Fonctionnement​

  1. La fonction envoie un événement serveur (gunware:sync:actionPlayer) avec l'action "player_me", en incluant l'identifiant du joueur et le message à afficher.

  2. Le serveur gère la diffusion de l'action /me pour qu'elle soit visible par les autres joueurs à proximité.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:player_me(2, "attrape un objet au sol et le range dans sa poche")

Dans cet exemple :

  • Le joueur avec l'identifiant 2 exécute une action /me qui affiche le message : "attrape un objet au sol et le range dans sa poche" aux autres joueurs à proximité.

showPlayerName (Client-side)​

Cette fonction permet d'afficher ou de masquer les noms des joueurs dans le jeu.

Syntaxe​

exports["gw-admin"]:showPlayerName()

Description​

La fonction showPlayerName bascule l'affichage des noms des joueurs dans le jeu en fonction de l'état actuel. Si les noms des joueurs sont déjà visibles, la fonction les masque, et si les noms sont cachés, elle les affiche. Cette fonctionnalité est utile pour les administrateurs ou les joueurs qui souhaitent activer ou désactiver cette option rapidement.

Elle utilise une variable cachée (client.cache.playerNames) pour déterminer l'état actuel (afficher ou masquer les noms des joueurs) et appelle la fonction showNames pour effectuer l'affichage en fonction de cette variable.

Fonctionnement​

  1. Inverse l'état de client.cache.playerNames (afficher/masquer les noms des joueurs).
  2. Appelle la fonction showNames avec la nouvelle valeur de client.cache.playerNames pour mettre à jour l'affichage des noms des joueurs.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:showPlayerName()

Lorsque cette ligne est appelée, l'affichage des noms des joueurs sera basculé (affiché ou masqué) en fonction de l'état précédent.

Voici la documentation pour la fonction showBlips :

showBlips (Client-side)​

Cette fonction permet d'activer ou de désactiver l'affichage des blips sur la carte pour le joueur. Un blip est une icône sur la carte qui représente un joueur, un lieu ou un objet spécifique.

Syntaxe​

exports["gw-admin"]:showBlips()

Description​

La fonction showBlips bascule l'état de l'affichage des blips sur la carte. Si les blips sont actuellement visibles, cette fonction les masquera, et s'ils sont masqués, elle les affichera. Le changement d'état est stocké dans la variable chow_blips_1.

Fonctionnement​

  1. La variable chow_blips_1 (qui contrôle l'affichage des blips) est inversée :
    • Si chow_blips_1 est vrai, les blips sont affichés.
    • Si chow_blips_1 est faux, les blips sont masqués.
  2. L'affichage des blips sur la carte est ensuite mis à jour en fonction de l'état de la variable.

Exécution​

Cette fonction est client-side, donc elle doit être exécutée sur le client.

Exemple d'utilisation​

exports["gw-admin"]:showBlips()

Lorsque cette ligne est exécutée, l'affichage des blips sur la carte sera basculé (affiché ou masqué) en fonction de l'état précédent.