SKZTurnBasedMatchInfo Class Reference

Inherits from NSObject
Declared in SKZTurnBasedMatchInfo.h

Overview

SKZTurnInformation is used to pass data about a turn based match between the Skillz SDK and a publisher’s game.

  id

Unique match id

@property (readonly) NSInteger id

Declared In

SKZTurnBasedMatchInfo.h

  matchDescription

Match description as configured in the Skillz Developer Portal

@property (readonly, nullable) NSString *matchDescription

Declared In

SKZTurnBasedMatchInfo.h

  entryCash

Cash entry fee, nil if there is none

@property (readonly, nullable) NSNumber *entryCash

Declared In

SKZTurnBasedMatchInfo.h

  entryPoints

Z points entry fee, nil if there is none

@property (readonly, nullable) NSNumber *entryPoints

Declared In

SKZTurnBasedMatchInfo.h

  isCash

Signifies a cash match

@property (readonly) BOOL isCash

Declared In

SKZTurnBasedMatchInfo.h

  name

Match name as configured in the Skillz Developer Portal

@property (readonly, nonnull) NSString *name

Declared In

SKZTurnBasedMatchInfo.h

  templateId

Template id for the template that the match is based on. These templates are configured in the Skillz Developer Portal

@property (readonly, nonnull) NSNumber *templateId

Declared In

SKZTurnBasedMatchInfo.h

  tournamentBeganDate

Date that this tournament began

@property (nonatomic, strong) NSDate *tournamentBeganDate

Declared In

SKZTurnBasedMatchInfo.h

  lastTurnCompletedDate

Date that the opponent completed their turn, will be nil if player is initiating and has not been matched

@property (nonatomic, strong) NSDate *lastTurnCompletedDate

Declared In

SKZTurnBasedMatchInfo.h

  opponentDisplayName

Display name used in Skillz for opponent, will be nil if player is initiating and has not been matched

@property (nonatomic, strong) NSString *opponentDisplayName

Discussion

DEPRECATED: use the display name field on the opponent object instead

Declared In

SKZTurnBasedMatchInfo.h

  opponentAvatarURL

URL for opponent’s Skillz avatar, will be nil if player is initiating and has not been matched

@property (nonatomic, strong) NSString *opponentAvatarURL

Discussion

DEPRECATED: use the avatar URL field on the opponent object instead

Declared In

SKZTurnBasedMatchInfo.h

  opponentUniqueId

Unique Id for opponent, use this to reference a player’s stored data, will be nil if player is initiating and has not been matched

@property (nonatomic, strong) NSString *opponentUniqueId

Discussion

DEPRECATED: use the id field on the opponent object instead

Declared In

SKZTurnBasedMatchInfo.h

  opponentCurrentTotalScore

Current total score for the current player’s opponent, if relevant to your game. Set when completing a turn, allows you to easily track and display total score without adjusting per round scoring. Used within the Skillz UI to display results.

@property (nonatomic, strong) NSString *opponentCurrentTotalScore

Discussion

DEPRECATED: use the current total score field on the opponent object instead

Declared In

SKZTurnBasedMatchInfo.h

  opponent

Current player’s opponent

@property (readonly) SKZTurnBasedPlayer *opponent

Declared In

SKZTurnBasedMatchInfo.h

  playerCurrentTotalScore

Current total score for the current player, if relevant to your game. Set by you when completing a turn, allows you to easily track and display total score without adjusting per round score. Used within the Skillz UI to display results.

@property (nonatomic, strong) NSString *playerCurrentTotalScore

Discussion

DEPRECATED: use the current total score field on the player object instead

Declared In

SKZTurnBasedMatchInfo.h

  playerDisplayName

Display name used in Skillz for current player

@property (nonatomic, strong) NSString *playerDisplayName

Discussion

DEPRECATED: use the display name field on the player object instead

Declared In

SKZTurnBasedMatchInfo.h

  playerAvatarURL

URL for current player’s Skillz avatar

@property (nonatomic, strong) NSString *playerAvatarURL

Discussion

DEPRECATED: use the avatar URL field on the player object instead

Declared In

SKZTurnBasedMatchInfo.h

  playerUniqueId

Unique ID for current player, use this to reference stored data for a given player

@property (nonatomic, strong) NSString *playerUniqueId

Discussion

DEPRECATED: use the id field on the player object instead

Declared In

SKZTurnBasedMatchInfo.h

  turnBasedPlayer

Current turn based player

@property (readonly) SKZTurnBasedPlayer *turnBasedPlayer

Declared In

SKZTurnBasedMatchInfo.h

  gameData

Base64 string encoded from NSData created by publisher used to create the game state for the current turn, will be nil for initiating turn if player has not been matched.

@property (nonatomic, strong) NSString *gameData

Declared In

SKZTurnBasedMatchInfo.h

  roundInformation

Array of SKZRoundResults objects corresponding to each round that has been completed so far. See SKZRoundResults for more information.

@property (nonatomic, strong) NSArray *roundInformation

Declared In

SKZTurnBasedMatchInfo.h

  currentTurnIndex

Index of current turn, for the first turn currentTurnIndex equals 0, and so on.

@property (nonatomic) NSInteger currentTurnIndex

Declared In

SKZTurnBasedMatchInfo.h

  prizePoints

The first place prize for the winner of this tournament, will be zero if this is a cash tournament

@property (nonatomic) NSInteger prizePoints

Declared In

SKZTurnBasedMatchInfo.h

  prizeCash

The first place prize for the winner of this tournmanet, will be zero if this is not a cash tournament

@property (nonatomic) CGFloat prizeCash

Declared In

SKZTurnBasedMatchInfo.h

  isGameComplete

Check this variable to determine whether your user is viewing an already complete match, or a match still in Progress

@property (nonatomic) BOOL isGameComplete

Declared In

SKZTurnBasedMatchInfo.h