QuasarApp/Snake
4
1
Fork 0
mirror of https://github.com/QuasarApp/Snake.git synced 2025-05-10 16:39:45 +00:00
Code Issues Projects Releases Wiki Activity

fix docs

Browse Source
This commit is contained in:
Andrei Yankovich 2021-08-08 15:37:34 +03:00
parent 4f541facd7
commit 959a838492
1 changed files with 20 additions and 20 deletions

40
src/Core/private/user.h

@ -24,75 +24,75 @@ class User : public QObject
/**
* @brief money This current user money count. An user can buy and sell game items using own money amount.
* @see User::setMoney
* @see User::money()
* @see User::getMoney
*/
Q_PROPERTY(int money READ money WRITE setMoney NOTIFY moneyChanged)
Q_PROPERTY(int money READ getMoney WRITE setMoney NOTIFY moneyChanged)
/**
* @brief xp This is experience count of an user. The experience unlock new tiers and make available new items for buying.
* @see User::setXp
* @see User::xp()
* @see User::getXp
* @see User::tier
* @see User::tier()
* @see User::getTier
*/
Q_PROPERTY(int xp READ xp WRITE setXp NOTIFY xpChanged)
Q_PROPERTY(int xp READ getXp WRITE setXp NOTIFY xpChanged)
/**
* @brief tier This us user tier. This value automaticaly generated by cuuren user experience count.
* @see User::xp
* @see User::xp()
* @see User::tier()
* @see User::getXp
* @see User::getTier
*/
Q_PROPERTY(int tier READ tier NOTIFY tierChanged)
Q_PROPERTY(int tier READ getTier NOTIFY tierChanged)
public:
User();
/**
* @brief money This current user money count. An user can buy and sell game items using own money amount.
* @brief getMoney This current user money count. An user can buy and sell game items using own money amount.
* @return current value of the User::money property
* @see User::setMoney
* @see User::money
*/
int money() const;
int getMoney() const;
/**
* @brief setMoney This method sets new value of the user money amount.
* @param newMoney this is new value of users money.
* @see User::money()
* @see User::getMoney
* @see User::money
*/
void setMoney(int newMoney);
/**
* @brief xp This is experience count of an user. The experience unlock new tiers and make available new items for buying.
* @brief getXp This is experience count of an user. The experience unlock new tiers and make available new items for buying.
* @return current user xpereans.
* @see User::setXp
* @see User::xp
* @see User::getXp
* @see User::tier
* @see User::tier()
* @see User::getTier
*/
int xp() const;
int getXp() const;
/**
* @brief setXp This method sets new value of the user experience.
* @param newXp This is new value of the users experience.
* @note This method can be change the User::tier property
* @see User::xp
* @see User::xp()
* @see User::getXp
* @see User::tier
* @see User::tier()
* @see User::getTier
*/
void setXp(int newXp);
/**
* @brief tier This us user tier. This value automaticaly generated by cuuren user experience count.
* @brief getTier This us user tier. This value automaticaly generated by cuuren user experience count.
* @return current value of the users tier.
* @see User::xp
* @see User::xp()
* @see User::getXp
* @see User::tier
*/
int tier();
int getTier();
/**
* @brief unlockedItems This method return set of the unlocked items of this user.