Difference between revisions of "TGame.OnLeave"

From Soldat Community Wiki
Jump to: navigation, search
m (Description)
m
Line 1: Line 1:
 
  '''''property OnLeave'''''
 
  '''''property OnLeave'''''
 
   Access mode: RW
 
   Access mode: RW
 +
  Event handler type: [[TOnLeaveGameEvent]]
 
   Event handler declaration: procedure (Player: [[TActivePlayer]]; Kicked: Boolean);
 
   Event handler declaration: procedure (Player: [[TActivePlayer]]; Kicked: Boolean);
  

Revision as of 12:33, 26 July 2013

property OnLeave
 Access mode: RW
 Event handler type: TOnLeaveGameEvent
 Event handler declaration: procedure (Player: TActivePlayer; Kicked: Boolean);

Description

Event property called when any player leaves the server or gets kicked/banned.

Example

 procedure MyOnLeaveHandler(Player: TActivePlayer; Kicked: Boolean);
 begin
   if Kicked then
     WriteLn(Player.Name + ' has been kicked!')
   else
     WriteLn(Player.Name + ' has left the game in peace')
 end;

 // ...

 begin
   // assign OnLeave handler
   Game.OnLeave := @MyOnLeaveHandler;

   // ...

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