Steam Lobby Response Display

Displays a message based on lobby join attempts; this handles localised strings with an optional fallback.
Fields and Attributes
Hide After Seconds
public float hideAfterSeconds;
Time in seconds before the display is automatically hidden. Set to 0 to disable auto-hide.
Success
public SteamText Success;
Message to display when the chat joins succeeds.
Doesnt Exist
public SteamText DoesntExist;
Message displayed if the chat does not exist (likely closed).
Not Allowed
public SteamText NotAllowed;
Message displayed when the user lacks permissions to join.
Full
public SteamText Full;
Message displayed when the chat room has reached its maximum capacity.
Error
public SteamText Error;
Message displayed for unexpected errors.
Banned
public SteamText Banned;
Message displayed if the user is banned from the chat.
Limited
public SteamText Limited;
Message displayed if the user account is limited.
Clan Disabled
public SteamText ClanDisabled;
Message displayed if the clan is locked or disabled.
Community Ban
public SteamText CommunityBan;
Message displayed if the user has a community ban preventing chat access.
Member Blocked You
public SteamText MemberBlockedYou;
Message displayed if a member in the chat has blocked the user.
You Blocked Member
public SteamText YouBlockedMember;
Message displayed if the user has blocked a member in the chat.
Rate Limit Exceeded
public SteamText RateLimitExceeded;
Message displayed if too many join attempts occurred in a short time.
Output Element
public TMPro.TMP_InputField outputElement;
UI element where the response text is displayed.
Display Element
public GameObject displayElement;
The GameObject that will be shown or hidden when displaying a response.
On Display
public UnityEvent onDisplay;
Event invoked when a response is displayed.
On Hide
public UnityEvent onHide;
Event invoked when the display is hidden.
Functions
Get String
public string GetString(EChatRoomEnterResponse response);
Returns the appropriate message string for the given EChatRoomEnterResponse
value.
Display Response
public void DisplayResponse(EChatRoomEnterResponse response);
Updates the outputElement
with the response message, shows the displayElement
, invokes onDisplay
, and optionally auto-hides after hideAfterSeconds
.
Hide Display
public void HideDisplay();
Hides the displayElement
and invokes the onHide
event.
Last updated