doc: Ajout de la documentation des méthodes

close #2
This commit is contained in:
rick 2021-06-01 00:31:17 +02:00
parent 3ede8c5f50
commit 2e27a49d73
Signed by: Rick
GPG key ID: 2B593F087240EE99

View file

@ -44,11 +44,19 @@ public void OnPluginStart()
PrintToServer("Hello world!");
}
/**
* Fonction trigger par levent cs_win_panel_matchk
* Envoie linformation que le match est fini.
*/
public void FinCarte(Event event, const char[] name, bool dontBroadcast)
{
ServeurLibre();
}
/**
* Commande pour tester le redémarrage dune partie (kick des personnes,
* notification au bot)
*/
public void TestRestart(Event event, const char[] name, bool dontBroadcast)
{
// TODO kick tout le monde
@ -67,12 +75,19 @@ public void TestRestart(Event event, const char[] name, bool dontBroadcast)
/* kick tout le monde */
}
/**
* Met le numéro de port dans la variable après le chargement de la config
*/
public void OnConfigsExecuted()
{
if (port < 0)
port = GetConVarInt(FindConVar("hostport"));
}
/**
* Lorsquune personne se connecte, vérifie sil peut se connecter.
* Si oui, la met dans la bonne équipe, sinon la kick.
*/
//public void OnClientAuthorized(int client, const char[] auth)
public void SetTeamPlayer(Event event, const char[] name, bool dontBroadcast)
{
@ -121,10 +136,9 @@ public void SetTeamPlayer(Event event, const char[] name, bool dontBroadcast)
}
}
/*
* !team
*
*
/**
* Commande pour enregistrer les équipes:
* !team ct NomEquipe id1 id2 id3 id4 id5
*/
public Action SetTeam(int args)
{
@ -156,8 +170,9 @@ public Action SetTeam(int args)
return Plugin_Handled;
}
/* envoie information plugin */
/**
* TODO: À supprimer
*/
public void OnMapVoteStarted()
{
// TODO kick tout le monde
@ -176,6 +191,10 @@ public void OnMapVoteStarted()
/* kick tout le monde */
}
/**
* Envoie une requete POST au bot pour lui indiquer que la partie est finie
* et que le serveur est libre.
*/
public void ServeurLibre()
{
/*
@ -190,6 +209,9 @@ public void ServeurLibre()
SocketConnect(socket, SocketEnvoieVictoire, OnSocketReceive, OnSocketDisconnected, MY_SOCKET_IP, MY_SOCKET_PORT);
}
/**
* Envoie une requete POST au bot avec les nouveaux scores
*/
public void UpdateScoreBoard(Event event, const char[] name, bool dontBroadcast)
{
// request post avec les scores des 2 équipes
@ -197,6 +219,9 @@ public void UpdateScoreBoard(Event event, const char[] name, bool dontBroadcast)
SocketConnect(socket, SocketUpdateScore, OnSocketReceive, OnSocketDisconnected, MY_SOCKET_IP, MY_SOCKET_PORT);
}
/**
* Commande de tests pour envoyant une requete avec le socket.
*/
public Action TestSocket(int args)
{
PrintToServer("envoie socket");
@ -205,6 +230,9 @@ public Action TestSocket(int args)
return Plugin_Handled;
}
/**
* Commande de tests pour envoyant une requete avec le socket.
*/
public Action TestSocketA(int args)
{
Handle socket = SocketCreate(SOCKET_TCP, OnSocketError);
@ -212,6 +240,9 @@ public Action TestSocketA(int args)
return Plugin_Handled;
}
/**
* Socket envoyant le score à la fin du round
*/
public void SocketUpdateScore(Handle socket, any arg)
{
char requestStr[1024];
@ -230,6 +261,9 @@ public void SocketUpdateScore(Handle socket, any arg)
CloseHandle(socket);
}
/**
* Socket envoyant la requete indiquant la fin du match
*/
public void SocketEnvoieVictoire(Handle socket, any arg)
{
char requestStr[1024];
@ -247,6 +281,8 @@ public void SocketEnvoieVictoire(Handle socket, any arg)
CloseHandle(socket);
}
/* Méthodes sockets universels */
public void OnSocketReceive(Handle socket, const char[] datas, const int data, any arg) {}
public OnSocketDisconnected(Handle socket, any arg)