SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
SetUserPositionRequest.h
1 //
2 // SetUserPositionRequest.h
3 // SFS2X
4 //
5 // Created by Lapo on 29/11/13.
6 // Copyright (c) 2013 A51 Integrated | http://a51integrated.com. All rights reserved.
7 //
8 
9 #import "BaseRequest.h"
10 #import "Vec3D.h"
11 #import "Room.h"
12 
13 extern NSString* const SetUserPositionRequest_KEY_ROOM;
14 extern NSString* const SetUserPositionRequest_KEY_VEC3D;
15 extern NSString* const SetUserPositionRequest_KEY_PLUS_USER_LIST;
16 extern NSString* const SetUserPositionRequest_KEY_MINUS_USER_LIST;
17 extern NSString* const SetUserPositionRequest_KEY_PLUS_ITEM_LIST;
18 extern NSString* const SetUserPositionRequest_KEY_MINUS_ITEM_LIST;
19 
20 
21 /** Updates the User position inside an MMORoom.
22 
23  MMORooms represent virtual environments and can host any number of users. Based on their position, the system allows users within a certain range from each other (Area of Interest, or AoI) to interact.
24  This request allows the current user to update his position inside the MMORoom, which in turn will trigger a [ISFSEvents onProximityListUpdate:] event for all users that fall within his AoI.
25 
26  @see MMORoom
27  @see [ISFSEvents onProximityListUpdate:]
28 
29  */
30 @interface SetUserPositionRequest : BaseRequest
31 
32 /**
33  @param pos the position in the MMORoom
34  @param theRoom MMORoom, can be nil in which case the last joined Room will be used
35 
36  @see MMORoom
37  @see [ISFSEvents onProximityListUpdate:]
38  */
39 +(id)requestWithPosition:(Vec3D*)pos mmoRoom:(id<Room>)theRoom;
40 
41 @end
Vec3D
Definition: Vec3D.h:26
SetUserPositionRequest
Definition: SetUserPositionRequest.h:30