Player/PlayerFallDamage.cs

Player component that applies fall damage when the player lands. It reads the landing velocity in Local.IPlayerEvents.OnLand, converts fall speed into damage either as a flat value or scaled between MaxSafeFallSpeed and FatalFallSpeed, records a fall death stat on the host, and applies the damage through IDamageable with a broadcast RPC and an owner-side fall sound.

/// <summary>
/// Apply fall damage to the player
/// </summary>
public class PlayerFallDamage : Component, Local.IPlayerEvents
{
	/// <summary>
	/// Off is the Garry's Mod style, a flat <see cref="FixedDamage"/> for any fall past the safe speed.
	/// </summary>
	[Title( "Realistic Fall Damage" ), Group( "Gameplay" ), ServerSettings.Section( "Players" ), Order( 6 )]
	[ConVar( "sandbox.falldamage_realistic", ConVarFlags.Replicated | ConVarFlags.Server | ConVarFlags.GameSetting, Help = "Fall damage scales with fall speed instead of a flat 10." )]
	public static bool RealisticFallDamage { get; set; } = false;

	[RequireComponent] public Player Player { get; set; }

	/// <summary>
	/// Fatal fall speed, you will die if you fall at or above this speed
	/// </summary>
	[Property] public float FatalFallSpeed { get; set; } = 1536.0f;

	/// <summary>
	/// Maximum safe fall speed, you won't take damage at or below this speed
	/// </summary>
	[Property] public float MaxSafeFallSpeed { get; set; } = 512.0f;

	/// <summary>
	/// Multiply damage amount by this much
	/// </summary>
	[Property] public float DamageMultiplier { get; set; } = 1.0f;

	/// <summary>
	/// Damage taken from any unsafe fall when realistic fall damage is off
	/// </summary>
	[Property] public float FixedDamage { get; set; } = 10.0f;

	/// <summary>
	/// Fall damage sound
	/// </summary>
	[Property] public SoundEvent FallSound { get; set; }

	[Rpc.Owner]
	private void PlayFallSound()
	{
		GameObject.PlaySound( FallSound );
	}

	void Local.IPlayerEvents.OnLand( float distance, Vector3 velocity )
	{
		var fallSpeed = Math.Max( -velocity.z, 0f );

		if ( fallSpeed <= MaxSafeFallSpeed )
			return;

		var damageAmount = RealisticFallDamage
			? MathX.Remap( fallSpeed, MaxSafeFallSpeed, FatalFallSpeed, 0f, 100f ) * DamageMultiplier
			: FixedDamage;
		if ( damageAmount < 1 ) return;

		if ( Networking.IsHost && damageAmount >= Player.Health )
			Player.PlayerData?.AddStat( "player.fall.death" );

		TakeFallDamage( damageAmount );
	}


	[Rpc.Broadcast]
	public void TakeFallDamage( float amount )
	{
		if ( !Networking.IsHost ) return;


		if ( Player is IDamageable damage )
		{
			var dmg = new DamageInfo( amount.CeilToInt(), Player.GameObject, null );
			dmg.Tags.Add( DamageTags.Fall );
			damage.OnDamage( dmg );

			PlayFallSound();
		}
	}
}