PlayerDisconnected hook, when is it called?

[iViscosity]

So clearly the PlayerDisconnected hook is called when someone disconnects from the server, but I was wondering if it's only called when they manually leave. In the recent release I made it's function relies on the PlayerDisconnected hook, but I don't want it to cause issues when people leave because they were karma kicked or kicked by an admin for some other reason. Is there a way to make it so that it is only caused if someone manually leaves the server and not if they are kicked by either an admin or karma?

[MrPresident]

It gets called when a player disconnects, for any reason.

kicked, banned, timed out, quits of their own accord. Any reason.

Essentially, as their player object is about to be deleted, it's called.

[iViscosity]

That is what I thought, thanks. Is there a hook or something that calls only when a player manually disconnects?

[iViscosity]

I have a related question, is there a way to capture when a person is about to leave, before they actually do? Like when they actually hit disconnect (or disconnect in the console), before they actually leave.

[MrPresident]

The PlayerDisconnect hook is called right before they actually disconnect I believe. Assuming they are not timing out that is.

It is called while the player object is still valid.

If you hook directly into the game event for disconnect, you might be able to tell the difference in the types of disconnects.

[MrPresident]

http://wiki.garrysmod.com/page/gameevent/Listen

[iViscosity]

Question about that since I've only used this once and had no need to get specifics from it, "string reason - Reason for disconnecting", how is this stored? Can I just access it like

Code: Lua

1.  
2. gameevent.Listen( "player_disconnect" )
3. hook.Add( "player_disconnect", "player_disconnect_example", function( data )
4.         local reason = data.reason
5.  
6.  
7.         if reason == "Disconnect by user." then
8.             -- The things I want it to do
9.         end
10. end )

or is there some other way to do it, or do you not know?

[Bytewave]

Question about that since I've only used this once and had no need to get specifics from it, "string reason - Reason for disconnecting", how is this stored? Can I just access it like

Code: Lua

1.  
2. gameevent.Listen( "player_disconnect" )
3. hook.Add( "player_disconnect", "player_disconnect_example", function( data )
4.         local reason = data.reason
5.  
6.  
7.         if reason == "Disconnect by user." then
8.             -- The things I want it to do
9.         end
10. end )

or is there some other way to do it, or do you not know?

According to this, the possible values are:

   "self", "kick", "ban", "cheat", "error"

That should be engine-wide. Don't know how it applies to GMod specifically, but I guess it's a good start.

And, yes, it should be just another key in the data table returned by the engine.

[MrPresident]

Just do some debug printing.

Print data.reason and have a player leave in the way you're looking for and you'll see exactly what it returns and what you should check for.

[iViscosity]

Just do some debug printing.

Print data.reason and have a player leave in the way you're looking for and you'll see exactly what it returns and what you should check for.

Oh yeah, I forgot you can find things by just testing it yourself.

[MrPresident]

Don't take this the wrong way.. but learning to properly debug code is one of the most important things you can do as a coder/programmer.

Once you figure out the little tricks of the trade, so to speak, it'll really set you above others.

You can figure out what is going on in code almost without fail all by yourself by just using debug printing break points. You can print various variables along the execution order to find all kinds of things.

[iViscosity]

Oh no I'm not, I just get lazy and forget I can try to find my own solutions