# int Squad::State()

[Family: Squad](/imperivm/en/CKS/familias/squad/)

## Exact signature

```text
int Squad::State()
```

## Description

Returns the squad's numeric state code as an integer obtained from an unsigned 16-bit value.

## Usage notes

Scripts compare this result with state constants such as SS_Approach and SS_ApproachWait. This entry does not enumerate the meaning of every code. Behavior with an invalid squad reference is not yet documented.

## Parameters and return type

**Return type:** `int`

The member is called on an object. Its receiver is not repeated among this signature’s arguments.

This signature takes no additional arguments.

## Read and share

- [Markdown](/imperivm/exports/en/cks/api-f4f4de70b800c3.md)
- [JSON](/imperivm/CKS/api/entries/api-f4f4de70b800c3?lang=en)

Keep the notes and limitations when reusing this description. Do not infer undocumented parameter meanings, units or effects.
