Class GameAnvilUser

constructor

• new GameAnvilUser(connector, serviceName, subId): GameAnvilUser

• 게임 서버에 접근하기 위한 유저의 새로운 인스턴스를 생성

  Parameters

  • connector: GameAnvilConnector

    커넥터
  • serviceName: string

    서비스 이름
  • subId: number

    추가 아이디 값(1 ~ 127)

  Returns GameAnvilUser

onAdminKickout

onForceLeaveRoom

onForceLogout

onMatchPartyCancel

onMatchPartyStart

onMatchUserDone

onMatchUserTimeout

onMoveChannel

onNotice

onSessionClose

channelId

• get channelId(): string

• Returns string

• set channelId(value): void
• Internal

  Parameters

  • value: string

  Returns void

isJoinedRoom

• get isJoinedRoom(): boolean

• 방에 입장해있는지 여부

  Returns boolean
• set isJoinedRoom(value): void

• Parameters

  • value: boolean

  Returns void

isLoggedIn

• get isLoggedIn(): boolean

• 로그인 하였는지 여부

  Returns boolean
• set isLoggedIn(value): void
• Internal

  Parameters

  • value: boolean

  Returns void

isPartyMatchInProgress

• get isPartyMatchInProgress(): boolean

• 현재 파티 매칭 중인지 여부

  Returns boolean
• set isPartyMatchInProgress(value): void

• Parameters

  • value: boolean

  Returns void

isUserMatchInProgress

• get isUserMatchInProgress(): boolean

• 현재 매칭 중인지 여부

  Returns boolean
• set isUserMatchInProgress(value): void

• Parameters

  • value: boolean

  Returns void

roomId

• get roomId(): number

• 방에 있을 때의 아이디

  만약 아니라면 이 값은 0

  Returns number
• set roomId(value): void

• Parameters

  • value: number

  Returns void

serviceId

• get serviceId(): number

• serviceName을 통해 가져온 서비스 아이디를 반환

  Returns number

serviceName

• get serviceName(): string

• 유저 생성할 때 지정한 서비스 이름을 반환

  Returns string
• set serviceName(value): void

• Parameters

  • value: string

  Returns void

subId

• get subId(): number

• 인스턴스를 만들 때 사용한 SubId

  Returns number
• set subId(value): void

• Parameters

  • value: number

  Returns void

userId

• get userId(): number

• 유저 아이디

  만약 0으면 로그인이 풀렸거나 로그인하지 않았음

  Returns number
• set userId(value): void

• Parameters

  • value: number

  Returns void

userType

• get userType(): string

• 로그인 시 지정한 유저 타입 정보

  Returns string
• set userType(value): void

• Parameters

  • value: string

  Returns void

clear

• clear(): void
• Internal

  Returns void

createRoom

• createRoom(roomName, roomType, matchingGroup, payload?): Promise<ErrorResult<ResultCodeCreateRoom, CreatedRoomResult>>

• 방을 생성하고 입장

  Parameters

  • roomName: string

    방 이름
  • roomType: string

    방 타입(서버 설정에서 정의)
  • matchingGroup: string

    매칭 시 사용할 그룹 정보
  • Optionalpayload: Payload

    추가 정보

  Returns Promise<ErrorResult<ResultCodeCreateRoom, CreatedRoomResult>>

  방 생성 결과

getAllChannelCountInfo

• getAllChannelCountInfo(serviceName): Promise<ErrorResult<ResultCodeAllChannelCountInfo, Map<string, ChannelCountInfo>>>

• 서버에 채널 유저 수 정보를 요청

  Parameters

  • serviceName: string

    채널 정보를 요청할 서비스

  Returns Promise<ErrorResult<ResultCodeAllChannelCountInfo, Map<string, ChannelCountInfo>>>

  채널 정보

getAllChannelInfo

• getAllChannelInfo(serviceName): Promise<ErrorResult<ResultCodeAllChannelInfo, Map<string, Payload>>>

• 서버에 채널 정보 요청

  Parameters

  • serviceName: string

    체널 정보를 요청할 서비스

  Returns Promise<ErrorResult<ResultCodeAllChannelInfo, Map<string, Payload>>>

  채널 정보

getChannelInfo

• getChannelInfo(serviceName, channelId): Promise<ErrorResult<ResultCodeChannelInfo, Payload>>

• 서버에 채널 정보 요청

  Parameters

  • serviceName: string

    채널 정보를 요청할 서비스
  • channelId: string

    채널 아이디

  Returns Promise<ErrorResult<ResultCodeChannelInfo, Payload>>

  채널 정보

internalReceiveSessionClose

• internalReceiveSessionClose(resultCode, payload): void
• Internal

  Parameters

  • resultCode: ResultCodeSessionClose
  • payload: Payload

  Returns void

joinRoom

• joinRoom(roomType, roomId, matchingUserCategory, payload?): Promise<void>

• 방에 입장

  Parameters

  • roomType: string

    방 타입(서버 설정에서 정의)
  • roomId: number

    방 아이디 정보
  • matchingUserCategory: string

    매칭 유저 정보
  • Optionalpayload: Payload

    추가 정보

  Returns Promise<void>

leaveRoom

• leaveRoom(payload?): Promise<ErrorResult<ResultCodeLeaveRoom, Payload>>

• 방에서 나온다

  Parameters

  • Optionalpayload: Payload

    추가 정보

  Returns Promise<ErrorResult<ResultCodeLeaveRoom, Payload>>

  호출 서버 응답

login

• login(userType, channelId, requestPayload?): Promise<ErrorResult<number, LoginResult>>

• 게임 서버에 로그인

  Parameters

  • userType: string

    서버와 맞춘 유저 타입
  • channelId: string

    채널 정보
  • OptionalrequestPayload: Payload

    추가 정보

  Returns Promise<ErrorResult<number, LoginResult>>

  로그인 결과

logout

• logout(): Promise<ErrorResult<ResultCodeLogout, LogoutResult>>

• 게임 서버에서 로그아웃

  Returns Promise<ErrorResult<ResultCodeLogout, LogoutResult>>

  로그아웃 결과

matchPartyCancel

• matchPartyCancel(roomType): Promise<ResultCodeMatchPartyCancel>

• 파티 매칭 취소 요청

  Parameters

  • roomType: string

    방 타입(서버 설정에서 정의)

  Returns Promise<ResultCodeMatchPartyCancel>

  호출 서버 응답

matchPartyStart

• matchPartyStart(roomType, matchingGroup, payload?): Promise<ErrorResult<ResultCodeMatchPartyStart, Payload>>

• 파티 매칭을 시작한다

  반환값으로 응답을 받고 onMatchPartyStart 로도 응답을 받는다

  파티 구성원들은 onMatchPartyStart 으로 응답을 받는다

  Parameters

  • roomType: string

    방 타입(서버 설정에서 정의)
  • matchingGroup: string

    매칭 시 사용할 그룹 정보
  • Optionalpayload: Payload

    추가 정보

  Returns Promise<ErrorResult<ResultCodeMatchPartyStart, Payload>>

  호출 서버 응답

matchRoom

• matchRoom(isCreateRoomIfNotJoinRoom, isMoveRoomIfJoinedRoom, roomType, matchingGroup, matchingUserCategory, payload?, leaveRoomPayload?): Promise<ErrorResult<ResultCodeMatchRoom, MatchResult>>

• 방 매칭 요청

  Parameters

  • isCreateRoomIfNotJoinRoom: boolean

    방이 없으면 생성한다
  • isMoveRoomIfJoinedRoom: boolean

    특정 상황에서 방을 옮겨갈 수 있다
  • roomType: string

    방 타입(서버 설정에서 정의)
  • matchingGroup: string

    매칭 시 사용할 그룹 정보
  • matchingUserCategory: string

    매칭 방에 유저 카테고리 정보 전달
  • Optionalpayload: Payload

    추가 정보
  • OptionalleaveRoomPayload: Payload

    만약 옮겨갈 때 사용할 추가 정보

  Returns Promise<ErrorResult<ResultCodeMatchRoom, MatchResult>>

  매칭 요청 결과

matchUserCancel

• matchUserCancel(roomType): Promise<ResultCodeMatchUserCancel>

• 매칭 취소 요청

  Parameters

  • roomType: string

    방 타입(서버 설정에서 정의)

  Returns Promise<ResultCodeMatchUserCancel>

  매칭 취소 요청 결과

matchUserStart

• matchUserStart(roomType, matchingGroup, payload?): Promise<ErrorResult<ResultCodeMatchUserStart, Payload>>

• 유저 매칭을 등록한다

  이 때 매칭 응답은 onMatchUserDone, onMatchUserTimeout 으로 받는다

  Parameters

  • roomType: string

    방 타입(서버 설정에서 정의)
  • matchingGroup: string

    매칭 시 사용할 그룹 정보
  • Optionalpayload: Payload

    추가 정보

  Returns Promise<ErrorResult<ResultCodeMatchUserStart, Payload>>

  매칭 등록 응답

moveChannel

• moveChannel(channelId, payload?): Promise<ErrorResult<ResultCodeMoveChannel, MoveChannelResult>>

• 지정한 채널로 이동

  Parameters

  • channelId: string

    이동할 채널의 아이디
  • Optionalpayload: Payload

    추가 정보

  Returns Promise<ErrorResult<ResultCodeMoveChannel, MoveChannelResult>>

  채널 이동 응답

namedRoom

• namedRoom(roomType, roomName, isParty, payload?): Promise<ErrorResult<ResultCodeNamedRoom, NamedRoomResult>>

• 지정한 이름의 방에 입장

  지정한 이름의 방이 없을 경우 지정한 이름의 방을 생성하고 해당 방에 입장한다

  Parameters

  • roomType: string

    방 타입(서버 설정에서 정의)
  • roomName: string

    입장하는 방의 이름
  • isParty: boolean

    파티 여부
  • Optionalpayload: Payload

    추가 정보

  Returns Promise<ErrorResult<ResultCodeNamedRoom, NamedRoomResult>>

  방 입장 결과

requestUser

• requestUser<TResponse>(messageOrPacket, tresponse): Promise<ErrorResult<ResultCode, TResponse>>

• 서버로 패킷을 보낸 후 응답 패킷 대기

  Type Parameters

  • TResponse extends IMessage

  Parameters

  • messageOrPacket: IMessage | Packet

    서버로 보낼 프로토 버퍼
  • tresponse: MessageDescriptor<TResponse>

    사용자 지정 응답

  Returns Promise<ErrorResult<ResultCode, TResponse>>

  시용자 지정 응답

requestUserInternal

• requestUserInternal(message): Promise<InternalPacket>
• Internal

  Parameters

  • message: IMessage

  Returns Promise<InternalPacket>

sendUser

• sendUser(message): void

• 게임 서버로 유저의 패킷 전송

  Parameters

  • message: IMessage

    서버로 보낼 프로토 버퍼 패킷

  Returns void

setJoinRoom

• setJoinRoom(isJoinedRoom, newRoomId): void
• Internal

  Parameters

  • isJoinedRoom: boolean
  • newRoomId: number

  Returns void

setJoinRoomFalse

• setJoinRoomFalse(): void

• 방 입장 정보를 리셋

  단순히 클라이언트 상에서 수치만 바꾼다

  이 메서드는 테스트나 연결 오류 등으로 필요시 사용할 것

  정식 절차로 방에서 나오는 것은 leaveRoom 메서드를 사용할 것

  Returns void

setMessageCallback

• setMessageCallback<TProtoBuffer>(descriptor, callback): void

• 서버에서 프로토 버퍼를 받았을 때 호출할 메서드를 지정

  만약 이미 있다면 삭제하고 인자로 받은 메서드를 사용 한다

  (주의) callback 은 비동기로 동작하므로 의도한 타이밍에 정확히 호출되지 않을 수 있음

  Type Parameters

  • TProtoBuffer extends IMessage

  Parameters

  • descriptor: MessageDescriptor<TProtoBuffer>

    지정할 프로토 버퍼
  • callback: ((gameAnvilUser: GameAnvilUser, resultCode: ResultCode, message: TProtoBuffer) => void)

    호출할 메서드 null일 수 없음

    • • (gameAnvilUser, resultCode, message): void

      • Parameters

        • gameAnvilUser: GameAnvilUser
        • resultCode: ResultCode
        • message: TProtoBuffer

        Returns void

  Returns void

snapshot

• snapshot(payload?): Promise<ErrorResult<ResultCodeSnapshot, Payload>>

• 현재 유저의 스냅샷 정보를 요청

  재접속 등 유저의 모든 정보를 갱신해야 할 필요가 있을 때 사용

  Parameters

  • Optionalpayload: Payload

    추가 정보

  Returns Promise<ErrorResult<ResultCodeSnapshot, Payload>>

  서버의 메서드에서 넣은 값