Whim Utilities

Satisfaction Rewards

Satisfaction Rewards Store

class CommonSatisfactionRewardStoreUtils

Bases: object

Utilities for manipulating the Satisfaction Rewards Store.

static add_reward_buff_to_rewards_store(reward_buff_definition_id, reward_point_cost)

Add a Reward Buff to the Satisfaction Rewards Store.

Parameters:
  • reward_buff_definition_id (int) – The decimal identifier of a Reward Buff.
  • reward_point_cost (int) – The amount of Satisfaction Reward Points the Reward Buff will cost the Sim to receive.
Returns:

True, if the Reward Buff was added to the Rewards Store successfully. False, if not.
Return type:

bool
static add_reward_cas_part_to_rewards_store(reward_cas_part_definition_id, reward_point_cost)

Add a Reward CAS Part to the Satisfaction Rewards Store.

Parameters:
  • reward_cas_part_definition_id (int) – The decimal identifier of a Reward CAS Part.
  • reward_point_cost (int) – The amount of Satisfaction Reward Points the Reward CAS Part will cost the Sim to receive.
Returns:

True, if the Reward CAS Part was added to the Rewards Store successfully. False, if not.
Return type:

bool
static add_reward_object_to_rewards_store(reward_object_definition_id, reward_point_cost)

Add a Reward Object to the Satisfaction Rewards Store.

Parameters:
  • reward_object_definition_id (int) – The decimal identifier of a Reward Object.
  • reward_point_cost (int) – The amount of Satisfaction Reward Points the Reward Object will cost the Sim to receive.
Returns:

True, if the Reward Object was added to the Rewards Store successfully. False, if not.
Return type:

bool
static add_reward_trait_to_rewards_store(reward_trait_definition_id, reward_point_cost)

Add a Reward Trait to the Satisfaction Rewards Store.

Parameters:
  • reward_trait_definition_id (int) – The decimal identifier of a Reward Trait.
  • reward_point_cost (int) – The amount of Satisfaction Reward Points the Reward Trait will cost the Sim to receive.
Returns:

True, if the Trait was added to the Rewards Store successfully. False, if not.
Return type:

bool
static get_all_satisfaction_reward_store_items_generator(include_satisfaction_reward_callback=None)

Retrieve all Satisfaction Rewards in the Satisfaction Rewards Store.

Parameters:include_satisfaction_reward_callback (Callable[[CommonRewardStoreItem]], bool], optional) – If the result of this callback is True, the Satisfaction Reward and Satisfaction Reward Data (Cost, Award Type), will be included in the results. If set to None, All Satisfaction Rewards will be included.
Returns:All items from the satisfaction reward store.
Return type:Iterator[CommonSatisfactionRewardStoreItem]
static remove_reward_from_rewards_store(reward_item_definition_id)

Remove a Reward Item from the Satisfaction Rewards Store.

Parameters:reward_item_definition_id (int) – The decimal identifier of a Reward Item.
Returns:True, if the Reward Item was removed from the Rewards Store successfully. False, if not.
Return type:bool

Satisfaction Reward Store Item

class CommonSatisfactionRewardStoreItem(reward, reward_cost, reward_type)

Bases: object

A wrapper for Reward Store Items.

Parameters:
  • reward (Reward) – An instance of a Reward.
  • reward_cost (int) – The amount of Satisfaction Reward Points the Reward costs.
  • reward_type (SatisfactionTracker.SatisfactionAwardTypes) – The type of the Reward.