# at.turtleme.game.sweepReef

> Published by [turtleme.at](https://lexicon.garden/identity/did:plc:f4h4tl43o4vx4hv2xps6siuz)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:f4h4tl43o4vx4hv2xps6siuz/at.turtleme.game.sweepReef)
- [Documentation](https://lexicon.garden/lexicon/did:plc:f4h4tl43o4vx4hv2xps6siuz/at.turtleme.game.sweepReef/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:f4h4tl43o4vx4hv2xps6siuz/at.turtleme.game.sweepReef/examples)

## Definitions

### `at.turtleme.game.sweepReef`

**Type**: `procedure`

Sweep one patch of the reef, or the handful a chord opens, in the order given. What comes back is the patches that opened and what each one counts, which is everything a board needs to be drawn and nothing more. Sweeping a patch with a turtle under it wakes the shoal and ends the board, and only a board swept clean pays anything. Requires an atproto service auth token addressed to did:web:turtleme.at#turtle_game and naming this method, so a token issued for one call cannot be spent on another.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `netted` | `array` | No | Where the player's nets are. They are the player's own marks and are not kept here; they are sent because a net stops a sweep spreading, the way a flag does. Leaving them out only opens more of the caller's own board. |
| `patches` | `array` | Yes | Which patches to sweep, in order. Sweeping stops at the first one that wakes the shoal. |

#### Output

**Encoding**: `application/json`

## Raw Schema

```json
{
  "id": "at.turtleme.game.sweepReef",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "patches"
          ],
          "properties": {
            "netted": {
              "type": "array",
              "items": {
                "type": "integer",
                "minimum": 0
              },
              "maxLength": 256,
              "description": "Where the player's nets are. They are the player's own marks and are not kept here; they are sent because a net stops a sweep spreading, the way a flag does. Leaving them out only opens more of the caller's own board."
            },
            "patches": {
              "type": "array",
              "items": {
                "type": "integer",
                "minimum": 0
              },
              "maxLength": 9,
              "minLength": 1,
              "description": "Which patches to sweep, in order. Sweeping stops at the first one that wakes the shoal."
            }
          }
        },
        "encoding": "application/json"
      },
      "output": {
        "schema": {
          "ref": "at.turtleme.game.defs#state",
          "type": "ref"
        },
        "encoding": "application/json"
      },
      "description": "Sweep one patch of the reef, or the handful a chord opens, in the order given. What comes back is the patches that opened and what each one counts, which is everything a board needs to be drawn and nothing more. Sweeping a patch with a turtle under it wakes the shoal and ends the board, and only a board swept clean pays anything. Requires an atproto service auth token addressed to did:web:turtleme.at#turtle_game and naming this method, so a token issued for one call cannot be spent on another."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```