# BooleanSetting

A simple boolean setting.

### Remarks

Can only be created while initializing the script.

### Example

```ts
const alwaysAttack = new BooleanSetting("AlwaysAttack", "If the module will always attack regardles of player health.", false);
```

### Extends

* [`Setting`](/api/breeze/settings/setting.md)

### Constructors

#### Constructor

> **new BooleanSetting**(`holder`, `name`, `description`, `defaultValue`): `BooleanSetting`

**Parameters**

**holder**

`object`

Can either be 'script' or a subgroup.

**name**

`string`

The name of the setting.

**description**

`string`

The description of the setting.

**defaultValue**

`boolean`

The default value of the setting.

**Returns**

`BooleanSetting`

**Overrides**

`Setting.constructor`

### Methods

#### description()

> **description**(): `string`

**Returns**

`string`

The description of the setting.

**Inherited from**

[`Setting`](/api/breeze/settings/setting.md).[`description`](/api/breeze/settings/setting.md#description)

***

#### getValue()

> **getValue**(): `boolean`

**Returns**

`boolean`

If the settings is toggled or not.

***

#### name()

> **name**(): `string`

**Returns**

`string`

The name of the setting.

**Inherited from**

[`Setting`](/api/breeze/settings/setting.md).[`name`](/api/breeze/settings/setting.md#name)

***

#### setValue()

> **setValue**(`value`): `void`

**Parameters**

**value**

`boolean`

The value to set the setting to.

**Returns**

`void`

***

#### visible()

> **visible**(`visible`): `void`

You can use this to hide settings temporarily depending on the user config. The callback should return a boolean.

**Parameters**

**visible**

`Function`

The function to determine if the setting should be visible or not.

**Returns**

`void`

**Example**

```ts
const delay = new IntSetting("Delay", "The amount of ticks to wait in between attacks.", false);

delay.visible(() => {
	return someOtherSetting.getValue()
});
```

**Inherited from**

[`Setting`](/api/breeze/settings/setting.md).[`visible`](/api/breeze/settings/setting.md#visible)


---

# Agent Instructions: 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:

```
GET https://scripting.breeze.rip/api/breeze/settings/booleansetting.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.