Difference between revisions of "TGame.OnLeave"

From Soldat Community Wiki
Jump to: navigation, search
m (Added missing semicolon)
m (Description)
Line 7: Line 7:
 
Event property called when any player leaves the server or gets kicked/banned.
 
Event property called when any player leaves the server or gets kicked/banned.
 
<br>
 
<br>
 +
{{note|Inside this event handler, player count is as if the player was still in game!}}
  
 
==Example==
 
==Example==

Revision as of 11:03, 10 September 2016

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.

Note: Inside this event handler, player count is as if the player was still in game!

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;