From dbb81a9384ac73f77e496dcacbbff61f171ae132 Mon Sep 17 00:00:00 2001 From: NotAdam Date: Thu, 4 Apr 2019 22:19:56 +1100 Subject: [PATCH] cleanup old func def, add docs for new funcs --- src/world/Action/Action.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/world/Action/Action.h b/src/world/Action/Action.h index 948aa15e..d31fe7b4 100644 --- a/src/world/Action/Action.h +++ b/src/world/Action/Action.h @@ -48,14 +48,15 @@ namespace Sapphire::Action bool isComboAction() const; /*! - * @brief Checks whether the source chara has the required stats/debuffs/etc to cast an action. - * @param subtractCosts Whether we should subtract the costs (eg, mp/tp) from the player or to just check them - * @return whether the requirements are met by the caster + * @brief Checks if a chara has enough resources available to cast the action (tp/mp/etc) + * @return true if they have the required resources */ - bool costCheck( bool subtractCosts = false ); - bool hasResources(); + /*! + * @brief Checks if a chara has enough resources available to cast the action and then consumes them (tp/mp/etc) + * @return true if they have the required resources + */ bool consumeResources(); /*!