Skip to content

Latest commit

 

History

History
168 lines (135 loc) · 4.77 KB

SCOTLANDYARDHELP.md

File metadata and controls

168 lines (135 loc) · 4.77 KB
Raw

Click here to go the the server help.

Scotland Yard Help

Scotland Yard is a game based on the original Scotland Yard board game. For an impression of the classical version, please check Wikipedia. The following will give you some insight in the messages that can be sent to a game of Scotland Yard and what kind of data you can expect to get back in return.

For the latest update on the messages, please check out the EMessages.h file for Scotland Yard.

Requests Messages

EMessage_SendGetMap

This will return the map to you using EMessage_RecvGetMap.

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<GAME ID>)

EMessage_SendGetSpyTravelLog

This will return the spy's travel log using EMessage_RecvGetSpyTravelLog.

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<GAME ID>)

TODO: Check in source for any more required payloads.

EMessage_SendGetPlayerLocations

This will return the locations of all players using EMessage_RecvGetPlayerLocations.

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<GAME ID>)

TODO: Check in source for any more required payloads.

EMessage_SendTravel

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<YOUR GAME ID>)
DATA_3: uint32_t(<DESTINATION>)
DATA_4: ETravelOption(<TRAVELOPTION>)

EMessage_SendGetLocation

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<GAME ID>)

TODO: Check in source for any more required payloads.

EMessage_SendGetTravelLog

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<GAME ID>)

EMessage_SendAmISpy

Will return if the player is a spy or not via EMessage_RecvAmISpy.

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<GAME ID>)

EMessage_SendWhoIsSpy

Will return the client id of the spy via EMessage_RecvWhoIsSpy.

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<GAME ID>)

EMessage_SendGetRemainingTokens

DATA_1: ClientID(<YOUR CLIENT ID>)
DATA_2: GameID(<GAME ID>)

Response Messages

EMessage_RecvGetMap

DATA_1: RakString(<MAPFILE>)

EMessage_RecvTravelResult

DATA_1: ETravelResult(<THE RESULT OF THE TRAVEL ACTION>)

EMessage_RecvGetSpyTravelLog

DATA_1: uint32_t(<NUMBER OF TRAVEL LOG ITEMS>)

DATA_2: uint32_t(<DESTINATION NODE ID OF TRAVEL LOG ITEM 1>)
DATA_3: ETravelOption(<TRAVEL OPTION OF TRAVEL LOG ITEM 1>)

DATA_...: Repeating DATA_2 and DATA_3 until the amount in DATA_1...

The destination node id's are 0 if the spy is hidden. In all the other turns where the spy reveals it's position, they are set just like in EMessage_RecvGetTravelLog.

EMessage_RecvGetPlayerLocations

DATA_1: EPlayer(<EPLAYER OF PLAYER 1>)
DATA_2: ClientID(<CLIENT ID OF PLAYER 1>)
DATA_3: uint32_t(<NODE NUMBER PLAYER 1 IS AT>)

DATA_...: Repeating for all players.

EMessage_RecvGetLocation

DATA_1: uint32_t(<LOCATION>)

EMessage_RecvAmISpy

Will return if the player is a spy or not.

DATA_1: bool(<VALUE>)

EMessage_RecvWhoIsSpy

Will return if the player is a spy or not.

DATA_1: unint32_t(<CLIENT ID OF SPY>)

EMessage_RecvGetTravelLog

DATA_1: uint32_t(<NUMBER OF TRAVEL LOG ITEMS>)

DATA_2: uint32_t(<DESTINATION NODE ID OF TRAVEL LOG ITEM 1>)
DATA_3: ETravelOption(<TRAVEL OPTION OF TRAVEL LOG ITEM 1>)

DATA_...: Repeating DATA_2 and DATA_3 until the amount in DATA_1...

EMessage_RecvGetRemainingTokens

Will inform the client the amount of tokens the player has. Can be requested using EMessage_SendGetRemainingTokens.

DATA_1: ETravelOption(<TRAVEL OPTION>)
DATA_2: uint32_t(<TOKENS FOR TRAVEL OPTION IN DATA_1>)
DATA_3: ETravelOption(<TRAVEL OPTION>)
DATA_4: uint32_t(<TOKENS FOR TRAVEL OPTION IN DATA_3>)
DATA_5: ETravelOption(<TRAVEL OPTION>)
DATA_6: uint32_t(<TOKENS FOR TRAVEL OPTION IN DATA_5>)

If the player requested is a spy. The following will also be sent.

DATA_7: ETravelOption(<TRAVEL OPTION>)
DATA_8: uint32_t(<TOKENS FOR TRAVEL OPTION IN DATA_7>)

Travel Options

There are multiple ways of transportation in this game. Below is a list of all the options.

  • ETravelOption_Taxi
  • ETravelOption_Bus
  • ETravelOption_Underground
  • ETravelOption_Ferry or ETravelOption_Black

For more info, please check out ETravelOption.h.

Travel Results

When receiving the EMessage_RecvTravelResult message, an ETravelResult sent with. Below is a list of possible results.

  • ETravelResult_NoTokensLeft
  • ETravelResult_NoValidTravelOption
  • ETravelResult_DestinationNotFree
  • ETravelResult_CaughtSpy
  • ETravelResult_Success

For more info, please check out ETravelResult.h.