[API] Health, previous states, and new events/event chaining

[PatPeter]

I'm creating my first plugin for Smod2 and I'm having quite a difficult time getting it to work. Here is a list of all the things I'd like to see in the API in the future that would make it easier to use.

• [x] In the Player class, a readonly public variable Health that allows reading the player's health. A method SetHealth would probably be needed for setting health positively, unless negative values can be supplied to Damage
• [x] OnAssignTeam is passed a Teams previousTeam parameter that allows checking the previous team of the player
• [x] OnSetClass is passed a TeamClass previousTeamClass parameter that allows checking of the previous class of the player
• [x] A new IEvent, OnPlayerSpawn, that is fired after the OnAssignTeam and OnSetClass events fire only when the player is physically in the server. Example use case: a player does friendly fire damage to other players and on respawn, the player is damaged equal to the damage done
• [x] A new IEvent, OnPlayerSpectate, that is fired after the OnPlayerDie event that functions the same as OnAssignTeam.
• [x] A new IEvent, OnPlayerEscape that triggers when Scientists or D-class escape the map. Use case: force scientists and d-class to drop their items when they escape.
• [ ] Either the ability to fire events from within events (such as killing a player after spawning as a punishment), or chaining events together, (for instance if a class is changed for OnSetClass, it calls another OnSetClass until teamclass == teamclassOutput)
• [x] A Vector as an out parameter in events that respawn players, so that players can be respawned in certain saved locations
• [ ] When spawnRagdoll = false, it should disable the hidden Vector that controls where a player will be respawned when the player is turned into SCP-049-2. If there's no ragdoll, there should be no respawn point other than SCP-049's spawn point.
• [x] A TeamClass factory so that TeamClass classes for a Classes value can be retrieved. I tried to do new TeamClass(), or modify an existing TeamClass with teamclassOutput.Team = Teams.SCP; teamclassOutput.ClassType = Classes.SCP_049_2;, but the TeamClass enums are readonly. I used Server.getClasses() and set it to a Dictionary in my plugin to finally get access to all the classes in the game.
• [x] The ability to change a player's respawn Vector to control where they respawn as zombies, or set the Vector to null and have them respawn in SCP-049's base

Let me explain what I am personally trying to do so that my requests will make more sense. I have an epidemic of zombies killing themselves intentionally either by tesla gate or by falling to their deaths in the Heavy Containment Y-junction.

If you're better off reading the code, here is my ZombieSuicideHotlineEventHandler.cs file.

These are all the things I've tried in the past 24-hours to get this working:

1. Respawn SCP-049-2 with health set to 999999 to survive the tesla gate, and then set back down to normal levels assuming they moved. There is no code for this because there is no interface for it, but this was one of my first thoughts. Also doesn't work with Y-junction deaths.
2. Fire a respawn event, such as OnPlayerSpawn, from OnPlayerDie, so that the player is immediately respawned. As mentioned above, the zombies would be instantly dead.
3. Change the player's class back to SCP-049-2 using player.ChangeClass in OnPlayerDie, and then teleport using player.Teleport to SCP-049's spawnpoint. player.ChangeClass and player.Teleport do not work in OnPlayerDie.
4. Add zombies that committed suicide to a Dictionary in the plugin in OnPlayerDie. Then, in OnSetClass if a player is flagged in zombieSuicides, set teamclassOutput to Classes.SCP_049_2. The event OnSetClass does not trigger when a player is killed and set to Spectator. If the player is spawned in in the next NTF/Chaos wave, the player will respawn as SCP-049-2 and die instantly to the tesla gate or infinite pit of death.
5. Add zombies to a Dictionary in OnPlayerDie. In OnSetClass, set the zombies to SCP-049 to respawn them in a safe space. Then, chain another OnSetClass by moving the player from zombieSuicides to deadDoctors and then set the player to SCP-049-2 in the second OnSetClass. Cannot chain events.

There are more that I thought of during development and I'll add them when I remember them.

I'm also putting all my ideas for plugins here that can't currently be implemented in the API as example use cases for implementing the suggestions above:

• Spawn Protection - NTF and Chaos have their health set to 999999 for 10 seconds after spawning in to prevent spawn camping
• Zombie Suicide Prevention - respawns zombies that kill themselves at a safe location
• Zombie Plague - Every human killed by a zombie becomes a zombie

[george-cosma]

Intresting ideas, I will get onto adding some of them in the near future, thank you for the suggestions!

[PatPeter]

It's so ironic that I went through all the effort of 17 builds to prevent zombies from killing themselves with the tesla gates and the developers decided to take tesla gates out of the game entirely :\

[Rnen]

In the IEventOnPlayerHurt, why not just check if the player's class is zombie (10) , like

switch ((int)player.Class.ClassType)
{
    case 10:
        if(type == DamageType.TESLA) { typeOutput = DamageType.NONE; damageOutput = 0f; }
        else goto default; 
        break;
    case default:
        typeOutput = type;
        damageOutput = damage;
        break;
}

[PatPeter]

@Rnen That would have worked for the (now defunct) tesla gates, but I was hoping for a solution that would work for both the tesla gates and the Y-junction infinite pit of deaths. Is there any way to teleport zombies after they've jumped to their own deaths in the infinite pits of death?

[ButterscotchV]

Added the suggestions about health modification

[Grover-c13]

1 - OnAssignTeam is only ever called on the initial round start, i know its a confusing event name. Ive renamed it. So previousTeam will always be unassigned or maybe RIP.

[Grover-c13]

2- Player.GetTeamClass should get the previous/current team class (its set after the event)

" Either the ability to fire events from within events (such as killing a player after spawning as a punishment), or chaining events together, (for instance if a class is changed for OnSetClass, it calls another OnSetClass until teamclass == teamclassOutput)" anyone can actually call events. Though this sounds like it could get into infinity loops easy unless im misunderstanding.

Use Player.ChangeRole to change role/teams. I know it can look a little confusing with a TeamRole class, a Team enum and then a Role enum. The TeamRole is just a bridging class and usually its just there to be a packet of information.

[PatPeter]

With the ability to pipe plugin events between each other, does this fulfill my original use case? I'll try coding event piping tomorrow.