#import <OFHighScore.h>
List of all members.
Member Function Documentation
- (void) _setBlob: |
|
(NSData *) |
_blob |
|
+ (NSArray*) allHighScoresForCurrentUser |
|
|
|
Retrieves the current user's high scores for all application leaderboards.
- Note:
- The rank property on the OFHighScore objects returned from this method will not be set.
- Returns:
- NSArray of OFHighScore objects; one for each leaderboard.
The blob needs to be explicity downloaded. After calling this the blob property will be filled out if we have data attached to this high score.
- Returns:
- OFRequestHandle for the server request. Use this to cancel the request
- Note:
- Invokes - (void)didDownloadBlob:(OFHighScore*)score; on success and
- (void)didFailDownloadBlob:(OFHighScore*)score; on failure
+ (OFRequestHandle*) getHighScoresNearCurrentUserForLeaderboard: |
|
(OFLeaderboard *) |
leaderboard |
andBetterCount: |
|
(uint) |
betterCount |
andWorseCount: |
|
(uint) |
worseCount |
|
|
| |
Get an NSArray* of scores near the users high score. The array will contain the users highscore in the middle of the worse and better scores.
- Parameters:
-
leaderboard | The leaderboard which you want to search for high scores. |
betterCount | The amount of scores you want that are better than the current user's score. Max is 50. |
worseCount | The amount of scores you want that are worse than the current user's score. Max is 50. |
- Returns:
- OFRequestHandle for the server request. Use this to cancel the request
- Note:
- Invokes - (void)didGetHighScoresNearCurrentUser:(NSArray*)scores; on success and
- (void)didFailGetHighScoresNearCurrentUser:(NSArray*)scores; on failure
+ (NSString*) getResourceName |
|
|
|
- (OFHighScore*) initForSubmissionWithScore: |
|
(int64_t) |
submitScore |
|
Initializes a HighScore for sumbittion. Use OFLeaderboard's submitScore: to submit this score to a leaderboard.
- Parameters:
-
submitScore | score to submit |
- Note:
- You may optionally also fillout the dispalyText customData blob properties before submission and after initialization.
- Returns:
- an initialized OFHighScore
- (id) initWithLocalSQL: |
|
(OFSqlQuery *) |
queryRow |
forUser: |
|
(OFUser *) |
hsUser |
rank: |
|
(NSUInteger) |
scoreRank |
|
|
| |
Submit score to a leaderboard
- Parameters:
-
leaderbard | The leaderboard to submit to. |
- Note:
- To create a high score to submit see OFHighScore's initForSubmissionWithScore: method.
- See also:
- OFHighScore
Property Documentation
- (NSData *) blob [read, write, retain] |
The data uploaded with this high score.
- Note:
- You must explicitly call downloadBlob on a highscore to have this data filled out.
- (OFS3UploadParameters *) blobUploadParameters [read, retain] |
- (NSString *) blobUrl [read, retain] |
- (NSString *) customData [read, write, retain] |
Arbitrary data attached to this score submission
- (NSString *) displayText [read, write, retain] |
Formatted string representation of score suitable for display
- (double) distance [read, assign] |
- (NSString *) gameCenterId [read, retain] |
- (NSString *) gameCenterName [read, write, retain] |
- (NSUInteger) gameCenterSeconds [read, assign] |
- (double) latitude [read, assign] |
- (NSString *) leaderboardId [read, retain] |
- (double) longitude [read, assign] |
- (NSInteger) rank [read, assign] |
Position on the leaderboard for this score. The best score has a rank of 1.
- Note:
- This field is only valid for scores that have been retrieved from the OpenFeint servers.
- (int64_t) score [read, write, assign] |
- (NSString *) toHighRankText [read, retain] |
- (OFUser *) user [read, assign] |
OpenFeint User who submitted this score
The documentation for this class was generated from the following file: