> For the complete documentation index, see [llms.txt](https://docs.flatredball.com/flatredball/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flatredball.com/flatredball/glue-reference/screen/custominitialize.md).

# CustomInitialize

A screen's CustomInitialize is the first method in *custom code* called after a screen is created. It is called before the screen performs any rendering, but after all of the screen's content has been loaded and after the objects defined in the FRB Editor have been initialized.

CustomInitialize can be used to perform any logic-based initialization. Examples of common types of initialization include:

* Loading custom data from disk such as loading a user profile from a JSON file
* Positioning the player based on spawn locations
* Adding events to factories to perform custom code when an entity is instantiated
* Assigning input devices based on plugged-in hardware or settings from previous screens
* Playing animations or intro sequences such as having a Gum overlay fade out or starting a countdown before the game begins


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flatredball.com/flatredball/glue-reference/screen/custominitialize.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
