mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
105 lines
3 KiB
YAML
105 lines
3 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: MatchmakingService
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
The service responsible for managing custom matchmaking data.
|
|
description: |
|
|
`Class.MatchmakingService` is responsible for managing custom matchmaking
|
|
attributes. Use it to read and write matchmaking data.
|
|
code_samples: []
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags:
|
|
- NotCreatable
|
|
- Service
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
properties: []
|
|
methods:
|
|
- name: MatchmakingService:GetServerAttribute
|
|
summary: |
|
|
Retrieves the value of a specific server attribute.
|
|
description: |
|
|
Retrieves the value of a specific server attribute.
|
|
code_samples: []
|
|
parameters:
|
|
- name: name
|
|
type: string
|
|
default:
|
|
summary: |
|
|
The name of the server attribute. Limited to a maximum of 50
|
|
characters.
|
|
returns:
|
|
- type: Tuple
|
|
summary: |
|
|
Returns the server attribute value if the attribute is found and if
|
|
the error is `nil`. Otherwise, returns `nil` for the attribute value
|
|
and an error message.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: MatchmakingService:InitializeServerAttributesForStudio
|
|
summary: |
|
|
Initiates the server attribute schema and its values to test in Studio.
|
|
description: |
|
|
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.
|
|
code_samples: []
|
|
parameters:
|
|
- name: serverAttributes
|
|
type: Dictionary
|
|
default:
|
|
summary: |
|
|
An array of attribute name-value pairs.
|
|
returns:
|
|
- type: Tuple
|
|
summary: |
|
|
Returns `true` if the call succeeded. Otherwise, returns `false` and
|
|
an error message.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: MatchmakingService:SetServerAttribute
|
|
summary: |
|
|
Assigns a value to a specific server attribute.
|
|
description: |
|
|
Assigns a value to a specific server attribute.
|
|
code_samples:
|
|
- Matchmaking-Service-Code-Sample
|
|
parameters:
|
|
- name: name
|
|
type: string
|
|
default:
|
|
summary: |
|
|
The name of the server attribute. Limited to a maximum of 50
|
|
characters.
|
|
- name: value
|
|
type: Variant
|
|
default:
|
|
summary: |
|
|
The value of the server attribute. Limited to a maximum of 50
|
|
characters.
|
|
returns:
|
|
- type: Tuple
|
|
summary: |
|
|
Returns `true` if the call succeeded. Otherwise, returns `false` and
|
|
an error message.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
events: []
|
|
callbacks: []
|