Firstborn/Assets/RPG Creation Kit/Scripts/Interfaces/IDamageable.cs
Schaken-Mods 959e80cf72 assets upload
assets upload description.
2023-03-28 12:16:30 -05:00

114 lines
3.0 KiB
C#

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using RPGCreationKit;
namespace RPGCreationKit
{
/// <summary>
/// Contains information about the damage received/gaved
/// </summary>
public class DamageContext
{
public float amount;
public Entity sender;
public bool wasBlocked;
public WeaponItem weaponItem;
public AmmoItem ammoItem;
public Spell spell;
public DamageContext(float _amount, Entity _sender, WeaponItem _weaponItem, AmmoItem _ammoItem, bool _wasBlocked, Spell _spell = null)
{
amount = _amount;
sender = _sender;
weaponItem = _weaponItem;
ammoItem = _ammoItem;
wasBlocked = _wasBlocked;
spell = _spell;
}
}
/// <summary>
/// Used on objects that has EntityAttributes on them an therefore can be damaged.
/// </summary>
public interface IDamageable
{
/// <summary>
/// Damages the Entity if a DamageContext is provided.
/// </summary>
/// <param name="damageContext"></param>
void Damage(DamageContext damageContext);
void DamageBlocked(DamageContext damageContext);
/// <summary>
/// Generates particle for the damaged object
/// </summary>
void GenerateBlood();
/// <summary>
/// Makes the Entity die.
/// </summary>
void Die();
/// <summary>
/// Returns true if the Entity is hostile.
/// </summary>
/// <returns></returns>
bool IsHostile();
/// <summary>
/// Returns true if the Entity is hostile against the Player Character.
/// </summary>
/// <returns></returns>
bool IsHostileAgainstPC();
/// <summary>
/// Returns true if the the Healthbar on the PlayerUI should be used when this entity is hostile.
/// </summary>
/// <returns></returns>
bool ShouldDisplayHealthIfHostile();
/// <summary>
/// Returns true if the target is alive.
/// </summary>
bool IsAlive();
/// <summary>
/// Returns true if the target is unconscious.
/// </summary>
/// <returns></returns>
bool IsUnconscious();
/// <summary>
/// Gets the max HP value of the Entity
/// </summary>
/// <returns></returns>
float GetMaxHP();
/// <summary>
/// Gets the current HP value of the Entity
/// </summary>
/// <returns></returns>
float GetCurrentHP();
/// <summary>
/// Gets the name of the Entity
/// </summary>
/// <returns></returns>
string GetEntityName();
/// <summary>
/// Gets the name of the Entity
/// </summary>
/// <returns></returns>
string GetEntityID();
Entity GetEntity();
bool Bleeds();
void InstantiateBlood(Vector3 pos);
}
}