๐Emotes
Stable - Can be used with minimal support by referencing documentation and examples
Overview
Emotes are used primarily to non-verbally communicate with other users.
Emote Selection - The set of emotes that appear in the Emote Wheel UI (
WBP_EmoteSelector
) are configured via the Roles table using the Emote Selection property.Emote Selection can be overridden at runtime via Blueprint on the
JM_PlayerEmoteComponent
Integration
Emotes are enabled by default in Origin and are accessed via the JM_PlayerEmoteComponent
Basic Usage
Pressing the emote action button (by default this is the B key on your keyboard) in game opens the Emote Wheel UI (WBP_EmoteSelector
). Users can play any of the visible emotes by clicking on the icons.
Alternatively, the Emote Wheel UI can be opened via the on screen button in the bottom right of the screen.
Configuring Emote Settings for Roles
Enabling/Disabling Emotes for a role
Emotes are defaulted to enabled for all roles, but can be disabled for a role in your project's roles data table by:
In your editor, enable
Emotes Enabled
in theRole Configuration Overrides
section of theRole Configuration
section of the roles data table to expose it.Change the
Emotes Enabled
setting totrue
orfalse
to enable or disable emotes for this role
Configuring Default Emote Selection
You can configure which emotes are available in your experience in your project's roles data table by:
In your editor, enable
Emote Selection
in the Role Configuration Overrides section of theRole Configuration
section of the roles data table to expose it.Assign a
J_EmoteSelectionData
asset to the Emote Selection setting.
By default these emotes are available:
Field | Description |
---|---|
Profile as Emote | Emote used to show the Player's profile picture |
Pick Me Emote | This emote is used in place of the Player's profile picture when Profile as Emote is disabled via the live config flag |
Emotes | This is an array containing all other emotes. To use the default |
Live Config Settings
All emote settings live in game.json
Key | Default Value | Description |
---|---|---|
Emotes.Enabled | true | Project wide setting to enable/disable emotes |
Emotes.EmoteWheelEnabled | true | Project wide setting to enable/disable the emote wheel UI |
Emotes.ClearEmoteSelectionOverridesOnRoleChanged | false | Setting to optionally clear all override settings on role changes. See Overriding Emote Settings at Runtime |
Emotes.MaxObjectPoolSize | 20 | Max number of Emote objects to pool. |
Emotes.MaxSoundDistance | 5000.0 | Max distance for emote sounds to be heard |
Last updated