Class: profile_store
GameSpy profile storage for awards and best scores.
Source
C++ class profile_store
Custom Constructor
profile_store
Remarks
Reads award and best-score data for the current online GameSpy profile.
Constructors
Constructor
protected new profile_store(): profile_store;Engine-created profile store.
Returns
profile_store
Methods
get_awards()
get_awards(): LuaIterable<award_pair_t>;Get award counters for the current profile.
Returns
LuaIterable<award_pair_t>
Award counters for the current profile.
Remarks
Values are meaningful after profile_store.load_current_profile completes successfully.
get_best_scores()
get_best_scores(): LuaIterable<best_scores_pair_t>;Get best score counters for the current profile.
Returns
LuaIterable<best_scores_pair_t>
Best score counters for the current profile.
Remarks
Values are meaningful after profile_store.load_current_profile completes successfully.
load_current_profile()
load_current_profile(onProgress: store_operation_cb, onComplete: store_operation_cb): void;Load awards and best scores for the current profile.
Parameters
| Parameter | Type | Description |
|---|---|---|
onProgress | store_operation_cb | Progress callback. |
onComplete | store_operation_cb | Completion callback. |
Returns
void
Remarks
Requires a current online profile. The completion callback reports the final result; the progress callback is accepted by the binding for profile-store operations.
stop_loading()
stop_loading(): void;Stop the active profile-store load request.
Returns
void
Remarks
Safe to call when no profile-store load is active.
Properties
at_award_massacre
readonly static at_award_massacre: 0;Engine enum value for profile_store.at_award_massacre.
at_awards_count
readonly static at_awards_count: 30;Engine enum value for profile_store.at_awards_count.
bst_backstabs_in_row
readonly static bst_backstabs_in_row: 2;Engine enum value for profile_store.bst_backstabs_in_row.
bst_bleed_kills_in_row
readonly static bst_bleed_kills_in_row: 2;Engine enum value for profile_store.bst_bleed_kills_in_row.
bst_explosive_kills_in_row
readonly static bst_explosive_kills_in_row: 3;Engine enum value for profile_store.bst_explosive_kills_in_row.
bst_eye_kills_in_row
readonly static bst_eye_kills_in_row: 4;Engine enum value for profile_store.bst_eye_kills_in_row.
bst_head_shots_in_row
readonly static bst_head_shots_in_row: 3;Engine enum value for profile_store.bst_head_shots_in_row.
bst_kills_in_row
readonly static bst_kills_in_row: 0;Engine enum value for profile_store.bst_kills_in_row.
bst_kinife_kills_in_row
readonly static bst_kinife_kills_in_row: 1;Engine enum value for profile_store.bst_kinife_kills_in_row.
bst_score_types_count
readonly static bst_score_types_count: 7;Engine enum value for profile_store.bst_score_types_count.