> For the complete documentation index, see [llms.txt](https://api.checkmein.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.checkmein.cloud/checkmein-4.0/database.md).

# Database

For each room in your game, a folder will be created. This folder contains all useful data about the room.

Each entry (Instance `Room`) contains:

* ObjectValue `Occupant`\
  \&#xNAN;*contains the room owner or nil if the room is unoccupied*
* BoolValue `DnD`\
  \&#xNAN;*contains the do not disturb value of the room*
* BoolValue `PrivateMode`\
  \&#xNAN;*contains the private mode value of the room (allows only room owner and roommates to enter)*
* BoolValue `Debounce`\
  \&#xNAN;*this value is true while the room door is opened*
* NumberValue `Number`\
  \&#xNAN;*contains the room number of the room*
* StringValue `Type`\
  \&#xNAN;*contains the room type of the room*
* NumberValue `Timer`\
  \&#xNAN;*contains the timer value of the room (amount in seconds the door remains open)*
* ObjectValue `Reference`\
  \&#xNAN;*contains a reference to the room door model belonging to this room*
* Folder `Roommates`\
  \&#xNAN;*contains the list of roommates of this room (ObjectValues containing the Players)*

{% hint style="warning" %}
To prevent unexpected behavior, do not change or add to these values directly through your own code. Consider them read-only. Use the supplied [API Functions](/checkmein-4.0/api-functions.md) instead.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://api.checkmein.cloud/checkmein-4.0/database.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.