Teams
Team Protocols and ready-to-go implementations. The CommandLineTeam can be used for fast developer interaction.
CommandLineEncryptor
Bases: Encryptor
A teammate who decides clues using the command line.
Source code in /home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 | |
decide_clues(code, context)
Decide clues for the given code using the command line.
| Parameters: |
|
|---|
| Returns: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
91 92 93 94 95 96 97 98 99 100 101 102 103 104 | |
print_context(context)
Print information for the developer to know how to interact through the command line.
| Parameters: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
78 79 80 81 82 83 84 85 86 87 88 89 | |
CommandLineGuesser
Bases: Guesser
A teammate who attempts to decipher their team's clues using the command line.
Source code in /home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | |
decipher_clues(clues, context)
Attempt to decipher the team's clues using the command line.
| Parameters: |
|
|---|
| Returns: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
195 196 197 198 199 200 201 202 203 204 205 206 207 208 | |
get_code_num(clue, context)
Attempt to decipher a single clue using the command line.
| Parameters: |
|
|---|
| Returns: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | |
print_context(context)
Print information for the developer to know how to interact through the command line.
| Parameters: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
162 163 164 165 166 167 168 169 170 171 172 | |
CommandLineIntercepter
Bases: Intercepter
A teammate who attempts to decipher the opposing team's clues using the command line.
Source code in /home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | |
get_code_num(clue, context)
Attempt to decipher a single opponent's clue using the command line.
| Parameters: |
|
|---|
| Returns: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | |
intercept_clues(opponent_clues, context)
Attempt to intercept the opposing team's clues using the command line.
| Parameters: |
|
|---|
| Returns: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
144 145 146 147 148 149 150 151 152 153 154 155 156 157 | |
print_context(context)
Print information for the developer to know how to interact through the command line.
| Parameters: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
109 110 111 112 113 114 115 116 117 118 119 120 | |
Encryptor
Bases: Protocol
Interface representing an Encryptor, a teammate who decides clues
Source code in /home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 | |
decide_clues(code, context)
Decide clues for the given code as an Encryptor given the team context and current game state.
| Parameters: |
|
|---|
| Returns: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
18 19 20 21 22 23 24 25 26 27 28 | |
Guesser
Bases: Protocol
Interface representing an Guesser, a teammate who attempts to decipher their team's clues
Source code in /home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 | |
decipher_clues(clues, context)
Attempt to decipher the clues provided by the team as a Guesser given the team context and current game state.
| Parameters: |
|
|---|
| Returns: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
48 49 50 51 52 53 54 55 56 57 58 | |
Intercepter
Bases: Protocol
Interface representing an Intercepter, a teammate who attempts to decipher the opposing team's clues
Source code in /home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 | |
intercept_clues(opponent_clues, context)
Attempt to decipher the opposing team's clues as an Intercepter given the team context and current game state.
| Parameters: |
|
|---|
| Returns: |
|
|---|
/home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
33 34 35 36 37 38 39 40 41 42 43 | |
Team
dataclass
Dataclass representing a team for a Decrypto game.
Source code in /home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
60 61 62 63 64 65 66 | |
TeamContext
dataclass
Dataclass representing the relevant information a team might consider
Source code in /home/docs/checkouts/readthedocs.org/user_builds/decryptogame/envs/latest/lib/python3.10/site-packages/decryptogame/teams.py
6 7 8 9 10 11 12 | |