# CustomEventReceiver

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/CustomEventReceiver/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/CustomEventReceiver

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

## Properties

### Source

```luau
CustomEventReceiver.Source: Instance
```

Attaches the [`CustomEventReceiver`](https://rapi.sleaze.dev/classes/CustomEventReceiver.md) object to a [`CustomEvent`](https://rapi.sleaze.dev/classes/CustomEvent.md).

## Methods

### GetCurrentValue

```luau
CustomEventReceiver:GetCurrentValue(): number
```

Returns the current value of the receiver's [`CustomEventReceiver.Source`](https://rapi.sleaze.dev/classes/CustomEventReceiver.md) property.

## Events

### EventConnected

```luau
CustomEventReceiver.EventConnected: RBXScriptSignal<(event: Instance)>
```

Fires when the receiver is attached to a different [`CustomEvent`](https://rapi.sleaze.dev/classes/CustomEvent.md), when the [`CustomEventReceiver.Source`](https://rapi.sleaze.dev/classes/CustomEventReceiver.md) property is changed.

### EventDisconnected

```luau
CustomEventReceiver.EventDisconnected: RBXScriptSignal<(event: Instance)>
```

Fires when the receiver is attached to a different [`CustomEvent`](https://rapi.sleaze.dev/classes/CustomEvent.md) instance when the [`CustomEventReceiver.Source`](https://rapi.sleaze.dev/classes/CustomEventReceiver.md) property is changed.

### SourceValueChanged

```luau
CustomEventReceiver.SourceValueChanged: RBXScriptSignal<(newValue: number)>
```

Fires when the value of the CustomEvent's source is changed, passing the CustomEvent's new value.

## 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`