Record¶
-
class
ourdestiny.d2record(record_request_json, record_data_json, profile_object)¶ Bases:
ourdestiny.common.d2displaypropertiesA class used to represent a record (or as they are normally known in game, Triumph).
Parameters: - record_request_json (dict) – The JSON obtained from the API containing live data, including completion states
- record_data_json (dict) – The JSON obtained from the database containing generic data
- profile_object (ourdestiny.d2profile) – The profile object that owns this record
Variables: - name (string) – The name of the record
- description (string) – The description of the record
- icon (string) – The URL of the icon for the record, if it has one
- hash (integer) – The hash of the record
- state (ourdestiny.d2recordstate) – The current state(s) of the record
- reward_items (list[ourdestiny.d2item]) – The items rewarded when completing this triumph, if there are any
- objectives (list[ourdestiny.d2recordobjective]) – A list of objectives to complete the record
- lore (ourdestiny.d2lore) – The lore of the record if it is a lore triumph
-
class
ourdestiny.d2recordobjective(objective_request_json, objective_data_json)¶ Bases:
ourdestiny.common.d2displaypropertiesA class used to represent an objective of a record
Parameters: - objective_request_json (dict) – The JSON obtained from the API containing live data about state of completion
- objective_data_json – The JSON obtained from the database containing generic definitions of the objective
Variables: - name (string) – Name of the objective, if it has one
- description (string) – Description of the objective, if it has one
- progress_description (string) – Text to describe the progress bar
- hash (integer) – The hash of the objective
- progress (integer) – The current progress on this objective
- completion_value (integer) – The value that must be reached for the objective to be complete
- complete (bool) – Displays whether the objective is complete
- visible (bool) – Displays whether the objective should be visible
- minimum_visibility_threshold (integer) – The lowest value the current progress should be before this objective is displayed
- allow_negative_value (bool) – Displays whether a negative value is allowed on this objecitve or not
- allow_value_change_when_completed (bool) – Displays whether value can change when the objective is completed or not
- allow_overcompletion (bool) – Displays whether progress will continue past the point of completion or not
- show_value_on_complete (bool) – Displays whether progress should be displayed once the objective is complete
- is_counting_downward (bool) – Displays whether the objective counts downwards or not
-
class
ourdestiny.d2recordstate(state_num)¶ A class representing the current states of a record - see https://bungie-net.github.io/multi/schema_Destiny-DestinyRecordState.html for more explanation
Parameters: state_num (integer) – The number obtained from the API which is used to determine states
Variables: - none (bool) – Indicates the record is in a state where it could be redeemed, but it has not been yet.
- record_redeemed (bool) – Indicates the completed record has been redeemed.
- record_unavailable (bool) – Indicates there’s a reward available from this Record but it’s unavailable for redemption.
- objective_not_completed (bool) – Indicates the objective for this Record has not yet been completed.
- obscured (bool) – Indicates that the game recommends that you replace the display text of this Record with DestinyRecordDefinition.stateInfo.obscuredString.
- invisible (bool) – Indicates that the game recommends that you not show this record. Do what you will with this recommendation
- entitlement_unowned (bool) – Indicates that you can’t complete this record because you lack some permission that’s required to complete it.
- can_equip_title (bool) – Indicates the record has a title and you can equip it.