SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
CreateSFSGameRequest.h
1 //
2 // CreateSFSGameRequest.h
3 // SFS2X
4 //
5 // Original development by Infosfer Game Technologies Ltd. | http://www.infosfer.com.
6 //
7 // Maintained and developed by A51 Integrated.
8 // Copyright 2012 A51 Integrated | http://a51integrated.com. All rights reserved.
9 //
10 
11 #import "BaseRequest.h"
12 
13 
14 EXTERN NSString * const CreateSFSGameRequest_KEY_IS_PUBLIC;
15 EXTERN NSString * const CreateSFSGameRequest_KEY_MIN_PLAYERS;
16 EXTERN NSString * const CreateSFSGameRequest_KEY_INVITED_PLAYERS;
17 EXTERN NSString * const CreateSFSGameRequest_KEY_SEARCHABLE_ROOMS;
18 EXTERN NSString * const CreateSFSGameRequest_KEY_PLAYER_MATCH_EXP;
19 EXTERN NSString * const CreateSFSGameRequest_KEY_SPECTATOR_MATCH_EXP;
20 EXTERN NSString * const CreateSFSGameRequest_KEY_INVITATION_EXPIRY;
21 EXTERN NSString * const CreateSFSGameRequest_KEY_LEAVE_ROOM;
22 EXTERN NSString * const CreateSFSGameRequest_KEY_NOTIFY_GAME_STARTED;
23 EXTERN NSString * const CreateSFSGameRequest_KEY_INVITATION_PARAMS;
24 
25 
26 @class CreateRoomRequest;
27 @class SFSGameSettings;
28 
29 /** The request launches a new public or private game, including game invitations, player matching and a lot more.
30 
31  The game is launched via the creation of an SFSGame, a specialized Room type that provides advanced features during the creation phase of a game.
32 
33  A more in-depth overview of the SFS2X Game API is provided in the general documentation
34 
35  @see SFSGame
36  @see SFSGameSettings
37  */
38 @interface CreateSFSGameRequest : BaseRequest {
39 @private
40  CreateRoomRequest *_createRoomRequest;
41  SFSGameSettings *_settings;
42 }
43 
44 @property (nonatomic, strong) CreateRoomRequest *createRoomRequest;
45 @property (nonatomic, strong) SFSGameSettings *settings;
46 
47 -(id)initWithSettings:(SFSGameSettings *)settings;
48 /**
49  @param settings the game Room settings
50 
51  @see SFSGameSettings
52  @see MatchExpression
53  @see SFSInvitation
54  @see [ISFSEvents onRoomAdd:]
55  @see [ISFSEvents onRoomCreationError:]
56 
57  */
58 +(id)requestWithSettings:(SFSGameSettings *)settings;
59 
60 @end
CreateSFSGameRequest
Definition: CreateSFSGameRequest.h:38
CreateRoomRequest
Definition: CreateRoomRequest.h:43
SFSGameSettings
Definition: SFSGameSettings.h:41