Class QuestDefinition

Inheritance Relationships

Base Type

Class Documentation

class QuestDefinition : public axr::sdk::EntityBase

Describes a single quest.

Public Functions

inline QuestDefinition()
inline QuestDefinition(const QuestDefinition &value)
inline QuestDefinition(QuestDefinition &&value)
inline virtual ~QuestDefinition()
inline virtual QuestDefinition &SetProperties(const std::map<utility::string_t, Variant> &value) override

Sets the object’s underlying map of stored values.

inline virtual QuestDefinition &SetProperties(std::map<utility::string_t, Variant> &&value) override

Sets the underlying map of stored values for the object.

inline virtual QuestDefinition &SetProperty(const utility::char_t *name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual QuestDefinition &SetProperty(const utility::string_t &name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual QuestDefinition &SetRemoteUrl(const utility::string_t &url) override

Returns the URL of the remote server endpoint where the object is managed.

inline virtual QuestDefinition &SetUid(const utility::string_t &value) override

Sets the value of the Uid property.

Parameters

value – The value to set.

inline virtual QuestDefinition &SetDateCreated(const datetime &value) override

Sets the value of the DateCreated property.

Parameters

value – The value to set.

inline virtual QuestDefinition &SetDateModified(const datetime &value) override

Sets the value of the DateModified property.

Parameters

value – The value to set.

inline virtual QuestDefinition &SetVersion(const uint64_t value) override

Sets the value of the Version property.

Parameters

value – The value to set.

virtual void Validate() override
utility::string_t GetName() const

The unique name of the quest.

utility::string_t GetTitle() const

A textual title or name of the quest.

utility::string_t GetDescription() const

A textual description of the quest.

utility::string_t GetIcon() const

The icon to display when representing the quest.

utility::string_t GetEntityUid() const

Returns the universally unique identifier of the entity that gives out the quest.

utility::string_t GetProductUid() const

The uid of the product that the zone is associated with.

std::vector<std::shared_ptr<QuestRequirement>> GetRequirements() const

The list of requirements that the persona must fulfill to complete the quest.

std::vector<std::shared_ptr<QuestReward>> GetRewards() const

The list of rewards that will be given once the quest has been completed.

datetime GetDateAvailable() const

Returns the date and time that the quest will be first made available. A 0 or invalid value indicates immediately available.

datetime GetDateFinished() const

Returns the date and time that the quest will no longer be available. A 0 or invalid value indicates no end date.

utility::string_t GetFrequency() const

The frequency that the quest can be repeated (e.g. 5m, 1h, 1w). A null value indicates that the quest cannot be repeated.

std::vector<std::shared_ptr<QuestRequirement>> GetUnlockRequirements() const

The list of requirements that the persona must meet to unlock the quest.

bool IsAutostart() const

Indicates whether or not quest progress will be started and tracked automatically.

std::shared_ptr<Object> GetData() const

Stores any custom data to be used by the product.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.