Class:CollectionService — roblox

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

The CollectionService class inherits from Instance.

Methods

AddTag(`instance`: Instance, `tag`: string): null

Custom Lua stateThis member uses the Lua C API directly.

Parameters
Name	Type
`instance`	Instance
`tag`	string

Thread safety: unsafe

GetAllTags(): Array

This class member is missing documentation. Create or add to its subpage at Class:CollectionService/GetAllTags.

Thread safety: safe

GetCollection(`class`: string): Instances

DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters
Name	Type
`class`	string

Thread safety: unsafe

GetInstanceAddedSignal(`tag`: string): RBXScriptSignal

Parameters
Name	Type
`tag`	string

Thread safety: unsafe

GetInstanceRemovedSignal(`tag`: string): RBXScriptSignal

Parameters
Name	Type
`tag`	string

Thread safety: unsafe

GetTagged(`tag`: string): Instances

Parameters
Name	Type
`tag`	string

Thread safety: safe

GetTags(`instance`: Instance): Array

Custom Lua stateThis member uses the Lua C API directly.

Parameters
Name	Type
`instance`	Instance

Thread safety: safe

HasTag(`instance`: Instance, `tag`: string): bool

Custom Lua stateThis member uses the Lua C API directly.

Parameters
Name	Type
`instance`	Instance
`tag`	string

Thread safety: safe

RemoveTag(`instance`: Instance, `tag`: string): null

Custom Lua stateThis member uses the Lua C API directly.

Parameters
Name	Type
`instance`	Instance
`tag`	string

Thread safety: unsafe

Events

ItemAdded(`instance`: Instance)

DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters
Name	Type
`instance`	Instance

Thread safety: unsafe

ItemRemoved(`instance`: Instance)

DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters
Name	Type
`instance`	Instance

Thread safety: unsafe

TagAdded(`tag`: string)

Parameters
Name	Type
`tag`	string

Thread safety: unsafe

TagRemoved(`tag`: string)

Parameters
Name	Type
`tag`	string

Thread safety: unsafe

External links

CollectionService in the Roblox Creator Documentation
CollectionService in the Roblox API Reference

Methods

AddTag(instance: Instance, tag: string): null

GetAllTags(): Array

GetCollection(class: string): Instances

GetInstanceAddedSignal(tag: string): RBXScriptSignal

GetInstanceRemovedSignal(tag: string): RBXScriptSignal

GetTagged(tag: string): Instances

GetTags(instance: Instance): Array

HasTag(instance: Instance, tag: string): bool

RemoveTag(instance: Instance, tag: string): null