Skip to content

Commit f84f13e

Browse files
committed
Warn about client-side tags being dropped
1 parent cb04623 commit f84f13e

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

content/en-us/reference/engine/classes/CollectionService.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ methods:
5151
signal created by `Class.CollectionService:GetInstanceAddedSignal()` with
5252
the given tag.
5353
54+
**Warning:** An instance's tags that were added client-side will be dropped if the server later adds or removes a tag on that instance, because the server replicates all tags together and overwrites previous tags.
55+
5456
**Warning:** When tagging an instance, it is common that some resources
5557
are used to give the tag its functionality, e.g. event connections or
5658
tables. To prevent memory leaks, it is a good idea to clean these up

content/en-us/reference/engine/classes/Instance.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,8 @@ methods:
321321
already applied. Successfully adding a tag will fire a signal created by
322322
`Class.CollectionService:GetInstanceAddedSignal()` with the given tag.
323323
324+
**Warning:** An instance's tags that were added client-side will be dropped if the server later adds or removes a tag on that instance, because the server replicates all tags together and overwrites previous tags.
325+
324326
Note that when tagging an instance, it's common that some resources are
325327
used to give the tag its functionality, for example event connections or
326328
tables. To prevent memory leaks, it's a good idea to clean these up

0 commit comments

Comments
 (0)