maj/StorytellersBestFriend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adds doxygen comments and MIT license comment to Abilities.h.

Browse Source
This commit is contained in:
Tom Hicks
2023-04-16 03:01:18 -07:00
parent 38014594ee
commit 382aa14611
1 changed files with 25 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
sbf-cpp/Abilities.h
View File

@@ -1,8 +1,20 @@
#ifndef ABILITIES_H__ #ifndef ABILITIES_H__
#define ABILITIES_H__ #define ABILITIES_H__
/***************************************************************************************
* @file Abilities.h
*
* @brief Defines AbiiltyType, ability and ability group constants, and ability and
* ability group functions.
* @copyright
* Copyright 2023 Tom Hicks
* Licensed under the MIT license see the LICENSE file for details.
***************************************************************************************/
#include <string> #include <string>
#include <vector> #include <vector>
/** \addtogroup Abilities
* @{
*/
namespace SBF { namespace SBF {
const int kAbilityTalentsId = 1; const int kAbilityTalentsId = 1;
const std::string kAbilityTalentsSingular = "Talent"; const std::string kAbilityTalentsSingular = "Talent";
@@ -158,30 +170,30 @@ namespace SBF {
/// @return True if left and right are not equal and false otherwise. /// @return True if left and right are not equal and false otherwise.
bool operator!=(const AbilityType& left, const AbilityType& right); bool operator!=(const AbilityType& left, const AbilityType& right);
/// @brief Fills the provided vector with all of the available ability groups. /// @brief Fills the provided vector with all of the available ability groups. It will be cleared before filling.
/// @param abilities The vector to fill. It will be cleared before filling. /// @param abilities The vector to fill.
void FillAbilities(std::vector<AbilityType>& abilities); void FillAbilities(std::vector<AbilityType>& abilities);
/// @brief Fills the provided vector with all of the ability labels in the specified group. /// @brief Fills the provided vector with all of the ability labels in the specified group. It will be cleared before filling.
/// @param abilities The vector to fill. It will be cleared before filling. /// @param abilities The vector to fill.
/// @param abilityGroupId The id of the ability group to fill for. /// @param abilityGroupId The id of the ability group to fill for.
void FillAbilitiesForAbilityGroup(std::vector<std::string>& abilities, int abilityGroupId); void FillAbilitiesForAbilityGroup(std::vector<std::string>& abilities, int abilityGroupId);
/// @brief Fills the provided vector with all of the ability labels in the specified group. /// @brief Fills the provided vector with all of the ability labels in the specified group. It will be cleared before filling.
/// @param labels The vector to fill. It will be cleared before filling. /// @param labels The vector to fill.
/// @param abilityGroupId The id of the ability group to fill for. /// @param abilityGroupId The id of the ability group to fill for.
void FillAbilityLabels(std::vector<std::string>& labels, int abilityGroupId); void FillAbilityLabels(std::vector<std::string>& labels, int abilityGroupId);
/// @brief Fills the provided vector with all of the knowledge labels. /// @brief Fills the provided vector with all of the knowledge labels. It will be cleared before filling.
/// @param knowledgeLabels The vector to fill. It will be cleared before filling. /// @param knowledgeLabels The vector to fill.
void FillKnowledgeLabels(std::vector<std::string>& knowledgeLabels); void FillKnowledgeLabels(std::vector<std::string>& knowledgeLabels);
/// @brief Fills the provided vector with all of the skill labels. /// @brief Fills the provided vector with all of the skill labels. It will be cleared before filling.
/// @param skillLabels The vector to fill. It will be cleared before filling. /// @param skillLabels The vector to fill.
void FillSkillLabels(std::vector<std::string>& skillLabels); void FillSkillLabels(std::vector<std::string>& skillLabels);
/// @brief Fills the provided vector with all of the talent labels. /// @brief Fills the provided vector with all of the talent labels. It will be cleared before filling.
/// @param talentLabels The vector to fill. It will be cleared before filling. /// @param talentLabels The vector to fill.
void FillTalentLabels(std::vector<std::string>& talentLabels); void FillTalentLabels(std::vector<std::string>& talentLabels);
/// @brief Gets an ability group for a given id. /// @brief Gets an ability group for a given id.
@@ -215,4 +227,5 @@ namespace SBF {
/// @return The label for the specific ability. /// @return The label for the specific ability.
const std::string GetTalentLabel(int talentId); const std::string GetTalentLabel(int talentId);
} // End namespace SBF } // End namespace SBF
/** @}*/
#endif // End !defined ABILITIES_H__ #endif // End !defined ABILITIES_H__