areadamageevents.c 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. //! Events used across AreaDamage API, calling of these needs to be handled by parent
  2. class AreaDamageEvents
  3. {
  4. ///@{
  5. //! Called when a trigger is created
  6. void OnTriggerCreated() {}
  7. //! Called when a trigger is destroyed
  8. void OnTriggerDestroyed() {}
  9. ///@}
  10. ///@{
  11. //! Called when an object enters the trigger
  12. void OnEnterBeginEvent(TriggerInsider insider) {}
  13. void OnEnterServerEvent(TriggerInsider insider) {}
  14. void OnEnterClientEvent(TriggerInsider insider) {}
  15. void OnEnterEndEvent(TriggerInsider insider) {}
  16. ///@}
  17. ///@{
  18. //! Called at the beginning of an update loop
  19. void OnStayStartBeginEvent(int nrOfInsiders) {}
  20. void OnStayStartServerEvent(int nrOfInsiders) {}
  21. void OnStayStartClientEvent(int nrOfInsiders) {}
  22. void OnStayStartEndEvent(int nrOfInsiders) {}
  23. ///@}
  24. ///@{
  25. //! Called in the update loop
  26. void OnStayBeginEvent(TriggerInsider insider, float deltaTime) {}
  27. void OnStayServerEvent(TriggerInsider insider, float deltaTime) {}
  28. void OnStayClientEvent(TriggerInsider insider, float deltaTime) {}
  29. void OnStayEndEvent(TriggerInsider insider, float deltaTime) {}
  30. ///@}
  31. ///@{
  32. //! Called at the end of an update loop
  33. void OnStayFinishBeginEvent() {}
  34. void OnStayFinishServerEvent() {}
  35. void OnStayFinishClientEvent() {}
  36. void OnStayFinishEndEvent() {}
  37. ///@}
  38. ///@{
  39. //! Called when an object leaves the trigger
  40. void OnLeaveBeginEvent(TriggerInsider insider) {}
  41. void OnLeaveServerEvent(TriggerInsider insider) {}
  42. void OnLeaveClientEvent(TriggerInsider insider) {}
  43. void OnLeaveEndEvent(TriggerInsider insider) {}
  44. ///@}
  45. ///@{
  46. //! Called when an object gets evaluated for taking damage
  47. protected bool OnEvaluateDamage(TriggerInsider insider, float damageCoef) { return false; }
  48. ///@}
  49. ///@{
  50. //! Called before an object is damaged (only when it actually damaged an object)
  51. protected void PreDamageActions() {}
  52. //! Called after an object was damaged (only when it actually damaged an object)
  53. protected void PostDamageActions() {}
  54. ///@}
  55. }