StreamUser

StreamUser

Class: StreamUser

Inherits: RefCounted < Object

Contains information about an user interacting with Crowd Control

Description

Objects of this class are used to give additional context to different events, most notably the profile icon of a user activating an effect. The profile icon is downloaded as soon as the object is instantiated and once finished the icon_downloaded signal is fired to allow waiting for it.

Properties

type	name	default
int	coins_spent	0
String	display_name	""
String	name	""
String	origin_id	""
String	origin_site	""
Texture2D	profile_icon	null
String	profile_icon_url	""
PackedStringArray	roles	PackedStringArray()
PackedStringArray	subscriptions	PackedStringArray()

Signals

icon_downloaded() : Emitted when the profile icon of this user has been successfully downloaded from the profile_icon_url.

Property Descriptions

int coins_spent [default: 0] : The amount of coins spent by this user.

String display_name [default: ""] : The name to use when displaying data about this user.

String name [default: ""] : The name to used to identify this user.

String origin_id [default: ""] : The id used to identify this user.

String origin_site [default: ""] : The site the user is using to interact with Crowd Control.

Texture2D profile_icon [default: null] : The profile picture of this user. Returns null if the download hasn't finished yet or failed.

String profile_icon_url [default: ""] : The url to the profile picture of this user.

PackedStringArray roles [default: PackedStringArray()] :

PackedStringArray subscriptions [default: PackedStringArray()] :