> ## Documentation Index
> Fetch the complete documentation index at: https://docs.forterulesengine.io/llms.txt
> Use this file to discover all available pages before exploring further.

# EffectOnChain

> v0.20.5

> **EffectOnChain** = `object`

Defined in: [src/modules/types.ts:148](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L148)

Structure of an effect as represented in the system

## Properties

### dynamicParam

> **dynamicParam**: `boolean`

Defined in: [src/modules/types.ts:152](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L152)

Whether the effect has dynamic parameters

***

### effectType

> **effectType**: [`EffectType`](../enumerations/EffectType)

Defined in: [src/modules/types.ts:154](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L154)

The type of effect

***

### errorMessage

> **errorMessage**: `string`

Defined in: [src/modules/types.ts:162](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L162)

Error message if applicable

***

### eventPlaceholderIndex

> **eventPlaceholderIndex**: `number`

Defined in: [src/modules/types.ts:165](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L165)

***

### instructionSet

> **instructionSet**: `any`\[]

Defined in: [src/modules/types.ts:164](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L164)

Instruction set for the effect

***

### param

> **param**: `any`

Defined in: [src/modules/types.ts:158](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L158)

Parameter value

***

### pType

> **pType**: `number`

Defined in: [src/modules/types.ts:156](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L156)

Parameter type

***

### text

> **text**: `Hex`

Defined in: [src/modules/types.ts:160](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L160)

Text representation in hex format

***

### valid

> **valid**: `boolean`

Defined in: [src/modules/types.ts:150](https://github.com/Forte-Service-Company-Ltd/forte-rules-engine-sdk/blob/40cc8388cecd8ee445b00b9df2b681cff8552ece/src/modules/types.ts#L150)

Whether the effect is valid