[gs-longan](../README.md) / ObjectState

# Class: ObjectState

## Hierarchy

- [`StateItem`](StateItem.md)

  ↳ **`ObjectState`**

  ↳↳ [`RenderObjectState`](RenderObjectState.md)

  ↳↳ [`CommandStepState`](CommandStepState.md)

## Table of contents

### Constructors

- [constructor](ObjectState.md#constructor)

### Properties

- [afterRoll](ObjectState.md#afterroll)
- [typeName](ObjectState.md#typename)
- [globalItemList](ObjectState.md#globalitemlist)

### Accessors

- [currentObject](ObjectState.md#currentobject)
- [currentRollType](ObjectState.md#currentrolltype)
- [name](ObjectState.md#name)
- [newObj](ObjectState.md#newobj)
- [object](ObjectState.md#object)
- [objectInNew](ObjectState.md#objectinnew)
- [oldObj](ObjectState.md#oldobj)
- [owner](ObjectState.md#owner)
- [tag](ObjectState.md#tag)

### Methods

- [dispose](ObjectState.md#dispose)
- [roll](ObjectState.md#roll)

## Constructors

### constructor

• **new ObjectState**(`object`, `oldObj`, `newObj`): [`ObjectState`](ObjectState.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `object` | `any` |
| `oldObj` | `any` |
| `newObj` | `any` |

#### Returns

[`ObjectState`](ObjectState.md)

#### Overrides

[StateItem](StateItem.md).[constructor](StateItem.md#constructor)

## Properties

### afterRoll

• **afterRoll**: [`List`](List.md)\<(`process`: [`Process`](Process.md), `rollType`: [`RollType`](../enums/RollType.md)) => `void`\>

#### Inherited from

[StateItem](StateItem.md).[afterRoll](StateItem.md#afterroll)

___

### typeName

• **typeName**: `string` = `"ObjectState"`

#### Overrides

[StateItem](StateItem.md).[typeName](StateItem.md#typename)

___

### globalItemList

▪ `Static` **globalItemList**: [`List`](List.md)\<[`StateItem`](StateItem.md)\>

#### Inherited from

[StateItem](StateItem.md).[globalItemList](StateItem.md#globalitemlist)

## Accessors

### currentObject

• `get` **currentObject**(): `any`

#### Returns

`any`

#### Inherited from

StateItem.currentObject

___

### currentRollType

• `get` **currentRollType**(): [`RollType`](../enums/RollType.md)

#### Returns

[`RollType`](../enums/RollType.md)

#### Inherited from

StateItem.currentRollType

___

### name

• `get` **name**(): `string`

#### Returns

`string`

#### Inherited from

StateItem.name

• `set` **name**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `string` |

#### Returns

`void`

#### Inherited from

StateItem.name

___

### newObj

• `get` **newObj**(): `any`

#### Returns

`any`

#### Inherited from

StateItem.newObj

• `set` **newObj**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `any` |

#### Returns

`void`

#### Inherited from

StateItem.newObj

___

### object

• `get` **object**(): `any`

#### Returns

`any`

___

### objectInNew

• `get` **objectInNew**(): `boolean`

#### Returns

`boolean`

#### Inherited from

StateItem.objectInNew

___

### oldObj

• `get` **oldObj**(): `any`

#### Returns

`any`

#### Inherited from

StateItem.oldObj

• `set` **oldObj**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `any` |

#### Returns

`void`

#### Inherited from

StateItem.oldObj

___

### owner

• `get` **owner**(): [`StatePack`](StatePack.md)

#### Returns

[`StatePack`](StatePack.md)

#### Inherited from

StateItem.owner

• `set` **owner**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | [`StatePack`](StatePack.md) |

#### Returns

`void`

#### Inherited from

StateItem.owner

___

### tag

• `get` **tag**(): `any`

#### Returns

`any`

#### Inherited from

StateItem.tag

• `set` **tag**(`value`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `any` |

#### Returns

`void`

#### Inherited from

StateItem.tag

## Methods

### dispose

▸ **dispose**(): `void`

#### Returns

`void`

#### Inherited from

[StateItem](StateItem.md).[dispose](StateItem.md#dispose)

___

### roll

▸ **roll**(`process`, `rollType`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `process` | [`Process`](Process.md) |
| `rollType` | [`RollType`](../enums/RollType.md) |

#### Returns

`void`

#### Overrides

[StateItem](StateItem.md).[roll](StateItem.md#roll)