Class
MatchmakingService
NotCreatableServiceNotReplicated
The service responsible for managing custom matchmaking data.
MatchmakingService is responsible for managing custom matchmaking
attributes. Use it to read and write matchmaking data.
Methods 3#
| GetServerAttribute | Retrieves the value of a specific server attribute. |
| InitializeServerAttributesForStudio | Initiates the server attribute schema and its values to test in Studio. |
| SetServerAttribute | Assigns a value to a specific server attribute. |
GetServerAttribute(name: string): Tuple#
Retrieves the value of a specific server attribute.
| Name | Type | Default | Description |
|---|---|---|---|
name | string | The name of the server attribute. Limited to a maximum of 50 characters. |
Returns
Tuple— Returns the server attribute value if the attribute is found and if the error isnil. Otherwise, returnsnilfor the attribute value and an error message.
InitializeServerAttributesForStudio(serverAttributes: Dictionary): Tuple#
Initiates the server attribute schema and its values to test in Studio. This method is optional and has no effect when running outside of Studio.
| Name | Type | Default | Description |
|---|---|---|---|
serverAttributes | Dictionary | An array of attribute name-value pairs. |
Returns
Tuple— Returnstrueif the call succeeded. Otherwise, returnsfalseand an error message.
SetServerAttribute(name: string, value: Variant): Tuple#
Assigns a value to a specific server attribute.
| Name | Type | Default | Description |
|---|---|---|---|
name | string | The name of the server attribute. Limited to a maximum of 50 characters. | |
value | Variant | The value of the server attribute. Limited to a maximum of 50 characters. |
Returns
Tuple— Returnstrueif the call succeeded. Otherwise, returnsfalseand an error message.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild