PcoWSkbVqDnWTu_dm2ix

In-Experience Profile

In-Experience Profile

It can be interesting to learn about other players. The ProfileCard developer module is a great way to see more information about others in a shared metaverse experience, from badges achieved to the player’s favorite games.

Module Usage

Installation

To use the ProfileCard module in an experience:

  1. Visit the ProfileCard marketplace page, click the green Get button, and confirm the transaction.
  2. In Studio, open the toolbox (ViewToolbox).
  3. Select your toolbox Inventory section.
  1. Locate the module item and click it or drag-and-drop it into the 3D view.
  2. In the Explorer window, move the entire ProfileCard folder into ServerScriptService. Upon running the experience, the module will distribute itself to various services and begin running.

This and other developer modules come with an Install script that runs the installer and distributes the contents of the module to the same services that the folders are named after.

The Install script can be utilized as follows:


EnableLogging — Set to true to enable debug logging for the current developer module. This lets you see how the module gets distributed, along with how each package is linked.


InstallStarted — Fires when the installer first starts up. You can hook into this event to run any pre-install steps.


InstallFinished — Fires when the installer has finished installing the module. By this point, the contents of each service folder has been distributed. You can also hook into this event to run any post-install steps.


Install() — Installs the given developer module by overlaying each of the service folders over existing services. For example, a folder named ReplicatedStorage containing a ProfileCard script will be distributed to game.ReplicatedStorage.ProfileCard when installing.


Views

Profile cards have different views depending on whether you’re viewing your own card or another player’s card.

When you first spawn into the experience, an icon appears over your character. Clicking the icon opens the profile card view. Once the card is closed, the icon disappears, but you can reopen the card at any time by clicking your character.

When viewing your own card, it appears as it would to another player, except placeholder text will appear for any blank inputs. Additionally, the status string is subject to text filtering, as any free text input should be.

Card Without Custom Status
Card With Custom Status
Entering a Custom Status
Attempt to Enter Invalid Status

Icons do not appear over other characters, but clicking on a character will open their profile card. The button in the upper-right corner of the card lets you quickly request that player as a friend.

Note that players under the age of 13 will only see the status message if it's appropriate for their age group.

Card With Custom Status
Card Without Custom Status

API Reference

Functions

configure()

void configure ( table config )

Overrides the default configurations with the given values. This function should be called from a LocalScript within StarterPlayerScripts.

Key Default Description
alwaysOnTop true If true, shows locator icons on top of everything, preventing them from being blocked by 3D world objects.
maxClickDistance 100 Maximum distance from the camera viewpoint a card will appear when a character is clicked, measured in studs.
backgroundColor Color3.fromRGB(228, 255, 255) Background color for the card.
backgroundTransparency 0.2 Transparency of the card's backgroundColor.

Previous Friends Locator Next Emote Bar