Skip to content

Add a code example to RBXScriptConnection #895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 31, 2024
Merged

Add a code example to RBXScriptConnection #895

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5265c09
Update RBXScriptConnection.yaml
WalkQuackBack Oct 30, 2024
891dca5
Merge branch 'Roblox:main' into patch-2
WalkQuackBack Oct 31, 2024
3c1ab56
Update RBXScriptConnection.yaml
IgnisRBX Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions content/en-us/reference/engine/datatypes/RBXScriptConnection.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,21 @@ type: datatype
summary: |
A connection between an `Datatype.RBXScriptSignal` and a function.
description: |
The `Datatype.RBXScriptConnection` data type, also known as a Connection, is a
special object returned by the Connect method of an Event
The `RBXScriptConnection` data type is a special object returned by the
`Datatype.RBXScriptSignal:Connect()|Connect()` method of an event
(`Datatype.RBXScriptSignal`). This is used primarily to disconnect a listener
from an `Datatype.RBXScriptSignal`.

```lua
local part : BasePart = script.Parent
-- Store reference to the RBXScriptConnection so it can be disconnected later
local connection : RBXScriptConnection = part.Touched:Connect(function(otherPart)
print("Hello world!")
end)
-- Wait 15 seconds, then disconnect
task.wait(15)
connection:Disconnect()
```
code_samples:
tags: []
deprecation_message: ''
Expand All @@ -18,8 +29,8 @@ properties:
summary: |
The state of the RBXScriptConnection.
description: |
Describes whether or not the connection is still alive. This becomes false
if `connection:Disconnect()` is called.
Describes whether or not the connection is still alive. This becomes `false`
if `Datatype.RBXScriptConnection:Disconnect()|Disconnect()` is called.
code_samples: []
tags: []
deprecation_message: ''
Expand Down
Loading