rojo/.cursor/rules/roblox/reference/engine/classes/TouchTransmitter.yaml
2026-02-02 12:08:47 -06:00

39 lines
1.5 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: TouchTransmitter
type: class
memory_category: Instances
summary: |
An internal object used by networking and replication code to transmit
`Class.BasePart.Touched` and `Class.BasePart.TouchEnded` events.
description: |
An internal object used by networking and replication code to transmit
`Class.BasePart.Touched` and `Class.BasePart.TouchEnded` events.
The TouchTransmitter object named 'TouchInterest' is created and parented to a
`Class.BasePart` when the `Class.BasePart.Touched` or
`Class.BasePart.TouchEnded` events are listened (connected) to.
Removing the TouchTransmitter will prevent the touched events from working.
The TouchTransmitter object can also be removed exclusively on the client.
This will prevent collisions from models the client has network ownership of
(such as the player's character) from registering.
Note, in almost all circumstances developers should disconnect the connection
using `Datatype.RBXScriptConnection:Disconnect()` method rather than removing
the TouchTransmitter. Otherwise the connection will not be cleaned up which
can cause performance issues over time.
code_samples: []
inherits:
- Instance
descendants: []
tags:
- NotCreatable
- NotBrowsable
deprecation_message: ''
properties: []
methods: []
events: []
callbacks: []