Scripting 12 - Listening on player melee action

[Gurt]

Scripting 12 - Listening on player melee action

Scripting in SFD assumes you have a fair knowledge of C#.

The following code demonstrates how to listen on player melee action events in v.1.3.0.

Code: Select all

public void OnStartup()
{
	Events.PlayerMeleeActionCallback.Start(OnPlayerMeleeAction);
}

 public void OnPlayerMeleeAction(IPlayer player, PlayerMeleeHitArg[] args) {
	// player performed a melee action. args contains all hit objects (if any).
	Game.WriteToConsole(string.Format("Player {0} hit {1} objects during melee {2}", player.UniqueID, args.Length, (player.IsKicking ? "kick" : "attack") ));
	foreach(PlayerMeleeHitArg arg in args) {
		Game.WriteToConsole(string.Format("Player {0} hit object {1} for {2} damage", player.UniqueID, arg.HitObject.UniqueID, arg.HitDamage));
	}
 }

ScriptAPI Implementation for PlayerMeleeActionCallback

► Show Spoiler

Code: Select all

	/// <summary>
    /// PlayerMeleeActionCallback.Event arguments
    /// </summary>
    [Serializable()]
    public struct PlayerMeleeHitArg
    {

        /// <summary>
        /// Gets the hit object ID.
        /// </summary>
        public readonly int ObjectID;

        /// <summary>
        /// Gets the hit object.
        /// </summary>
        public readonly IObject HitObject;

        /// <summary>
        /// Gets the hit position.
        /// </summary>
        public readonly Vector2 HitPosition;

        /// <summary>
        /// Gets if the HitObject is a player.
        /// </summary>
        public readonly bool IsPlayer;

        /// <summary>
        /// Gets the hit damage done.
        /// </summary>
        public readonly float HitDamage;

    }