> For the complete documentation index, see [llms.txt](https://wiki.thescriptersguild.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.thescriptersguild.com/scripting/nodes/game-mode-firefight/get-firefight-custom-set-state.md).

# Get Firefight Custom Set State

![](/files/a03EGvGlESedUNlJAULd)

## Description

Returns information about the currently running Firefight Custom Set. If no Custom Set is active, Custom Set Active will be FALSE and 1 as appropriate. Input pins determine the value in Forge to facilitate script testing. Only works in Firefight Custom.

## Node Type

Nodes fall into two basic categories: Data and Execution. This node supplies Data for an Execution node.

## Inputs

| Input          | Type    | Required | Description                                                                  |
| -------------- | ------- | -------- | ---------------------------------------------------------------------------- |
| Value In Forge | Boolean | Yes      | Sets if "Custom Set Is Active" should be true or false when testing in Forge |
| Value In Forge | Boolean | Yes      | Sets if "Is First Set" should be true or false when testing in Forge         |
| Value In Forge | Boolean | Yes      | Sets if "Could Be Final Set" should be true or false when testing in Forge   |
| Value In Forge | Number  | Yes      | Sets which "Group Index" should be detected as active in Forge               |

## Outputs

| Output               | Type    | Description                                           |
| -------------------- | ------- | ----------------------------------------------------- |
| Custom Set Is Active | Boolean | Which Custom Set is currently active.                 |
| Is First Set         | Boolean | Is TRUE if current custom set is the first set.       |
| Could Be Final Set   | Boolean | Is TRUE if current custom set could be the final set. |
| Active Group Index   | Number  | Which Group Index is currently active.                |

\
\
**Contributors**

AddiCt3d 2CHa0s


---

# 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://wiki.thescriptersguild.com/scripting/nodes/game-mode-firefight/get-firefight-custom-set-state.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.