# CustomEvent

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Deprecated
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/CustomEvent/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/CustomEvent

**Deprecated:** `CustomEvents` have been superseded by `BindableEvents` and should not be used in new work.

## Properties

### PersistedCurrentValue

```luau
CustomEvent.PersistedCurrentValue: number = 0
```

- Tags: Hidden, Not scriptable

## Methods

### GetAttachedReceivers

```luau
CustomEvent:GetAttachedReceivers(): { Instance }
```

Returns the `CustomEventReceivers` that are connected to the [`CustomEvent`](https://rapi.sleaze.dev/classes/CustomEvent.md).

### SetValue

```luau
CustomEvent:SetValue(newValue: number)
```

Sets the value of the [`CustomEvent`](https://rapi.sleaze.dev/classes/CustomEvent.md) and fires the [`CustomEventReceiver.SourceValueChanged`](https://rapi.sleaze.dev/classes/CustomEventReceiver.md) event for all connected `CustomEventReceiver|receivers`.

## Events

### ReceiverConnected

```luau
CustomEvent.ReceiverConnected: RBXScriptSignal<(receiver: Instance)>
```

Fires when a receiver is connected to the [`CustomEvent`](https://rapi.sleaze.dev/classes/CustomEvent.md).

### ReceiverDisconnected

```luau
CustomEvent.ReceiverDisconnected: RBXScriptSignal<(receiver: Instance)>
```

Fires when a receiver is disconnected from the [`CustomEvent`](https://rapi.sleaze.dev/classes/CustomEvent.md).

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`