AddEmote
Unsafe
For thread safety, this property is not safe to read in an unsynchronized thread.
AddEmote will add an Emote asset to the description given a name and its asset ID. The asset ID must be for an “Emote” asset (see Featured emotes in the Catalog).
You can add multiple emotes of the same name. All emotes of the same name can be removed using HumanoidDescription/RemoveEmote|RemoveEmote. If an emote with the same ID is added under the same name, HumanoidDescription/EmotesChanged|EmotesChanged fires.
See also
articles/HumanoidDescription System, for more information on HumanoidDescriptionsHumanoidDescription/RemoveEmote|GetEmotes, which can be used to retrieve the emotes that have been added by this functionHumanoidDescription/SetEmotes|SetEmotesandHumanoidDescription/RemoveEmote|RemoveEmote, which also manipulate what emotes have been addedHumanoidDescription/EmotesChanged|EmotesChanged, which fires after this function is called
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
|
|
A string that identifies what emote is being added. Example: |
||
|
|
An emote asset ID (see Featured emotes in the Catalog). Example: |
Returns
| Return Type | Summary |
|---|---|