TGame.OnRequest

From Soldat Community Wiki
Jump to: navigation, search
property OnRequest
 Access mode: RW
 Event handler type: TOnRequestEvent
 Event handler declaration: 
   function (Ip, Hw: string; Port: Word; State: Byte; Forwarded: Boolean; Password: string): Integer;

Description

Event property called when a player connects with a server in order to join.

State Value Description
1 OK
2 Wrong Soldat version
3 Wrong password
4 Banned
5 Server full
6 Duplicate IP

Example

Example allows players to join even if they enter wrong password

 function MyOnRequestHandler(Ip, Hw: string; Port: Word; State: Byte; Forwarded: Boolean; Password: string): Integer;
 begin
   if (State = 3) then
     State := 1;
   Result := State;
 end;

 // ...

 begin
   // assign OnRequest handler
   Game.OnRequest := @MyOnRequestHandler;

   // ...

   // unassign
   Game.OnRequest := nil;
 end;