---
title: CardState
framework: tabletopkit
role: symbol
role_heading: Structure
path: tabletopkit/cardstate
---

# CardState

A state for cards that contains face up and down information.

## Declaration

```swift
struct CardState
```

## Topics

### Creating a card state

- [init(faceUp:parentID:seatControl:pose:boundingBox:)](tabletopkit/cardstate/init(faceup:parentid:seatcontrol:pose:boundingbox:).md)
- [init(faceUp:parentID:seatControl:pose:entity:)](tabletopkit/cardstate/init(faceup:parentid:seatcontrol:pose:entity:).md)
- [faceDown(parentID:seatControl:pose:boundingBox:)](tabletopkit/cardstate/facedown(parentid:seatcontrol:pose:boundingbox:).md)
- [faceDown(parentID:seatControl:pose:entity:)](tabletopkit/cardstate/facedown(parentid:seatcontrol:pose:entity:).md)
- [faceUp(parentID:seatControl:pose:boundingBox:)](tabletopkit/cardstate/faceup(parentid:seatcontrol:pose:boundingbox:).md)
- [faceUp(parentID:seatControl:pose:entity:)](tabletopkit/cardstate/faceup(parentid:seatcontrol:pose:entity:).md)

### Getting the card data

- [faceUp](tabletopkit/cardstate/faceup.md)

### Getting the parent equipment

- [parentID](tabletopkit/cardstate/parentid.md)

### Rendering the equipment

- [boundingBox](tabletopkit/cardstate/boundingbox.md)
- [pose](tabletopkit/cardstate/pose.md)

### Controlling the equipment

- [lockedBy](tabletopkit/cardstate/lockedby.md)
- [seatControl](tabletopkit/cardstate/seatcontrol.md)

## Relationships

### Conforms To

- [BitwiseCopyable](swift/bitwisecopyable.md)
- [Copyable](swift/copyable.md)
- [Equatable](swift/equatable.md)
- [EquipmentState](tabletopkit/equipmentstate.md)
- [Escapable](swift/escapable.md)
- [MutableEquipmentState](tabletopkit/mutableequipmentstate.md)
- [Sendable](swift/sendable.md)
- [SendableMetatype](swift/sendablemetatype.md)

## See Also

### Equipment

- [Implementing playing card overlap and physical characteristics](tabletopkit/implementing-playing-card-overlap-and-physical-characteristics.md)
- [Equipment](tabletopkit/equipment.md)
- [EquipmentCollection](tabletopkit/equipmentcollection.md)
- [EntityEquipment](tabletopkit/entityequipment.md)
- [EquipmentIdentifier](tabletopkit/equipmentidentifier.md)
- [EquipmentState](tabletopkit/equipmentstate.md)
- [EquipmentStateCollection](tabletopkit/equipmentstatecollection.md)
- [BaseEquipmentState](tabletopkit/baseequipmentstate.md)
- [CustomEquipmentState](tabletopkit/customequipmentstate.md)
- [MutableEquipmentState](tabletopkit/mutableequipmentstate.md)
- [DieState](tabletopkit/diestate.md)
- [RawValueState](tabletopkit/rawvaluestate.md)
- [ControllingSeats](tabletopkit/controllingseats.md)