Access to certain information and functions about a user. More...

Inheritance diagram for IUser:

abstract string	Name `[get]`
	Gets the name of the user. This is the user's in-game character name. More...

abstract long	UserID `[get]`

abstract int	UserIdentifier `[get]`
	Gets the unique user identifier. More...

abstract int	GameSlotIndex `[get]`
	Gets the game slot index (lobby slot index) this user occupies. Returns -1 for users not connected to any game slot (for example auto created bots in certain situations). More...

abstract bool	IsHost `[get]`
	Gets if this is the host. More...

abstract bool	IsModerator `[get]`
	Gets if this user is a moderator. More...

abstract bool	Spectating `[get]`
	Gets if the user is currently spectating. This is true while a recently connected user is waiting for the next round. More...

abstract bool	JoinedAsSpectator `[get]`
	Gets if this user joined as a spectator. Spectators will not interact with the game other than chatting. Note: Currently not possible to join as a spectator but may be in the future. More...

abstract int	Ping `[get]`
	Gets the ping (Average roundtrip time in ms to the server as the server sees it). More...

abstract string	ConnectionIP `[get]`
	Gets the user's connection IP if the game is running in a server. Returns empty string for bots. Returns "localhost" for players playing on the same computer as the server. More...

abstract string	AccountID `[get]`
	Gets the user's account ID as Superfighters Deluxe will track the account. Returns empty string for bots. Returns empty string if user is offline / server allow anonymous users / user is not logged in. More...

abstract string	AccountName `[get]`
	Gets the user's account Name as Superfighters Deluxe will track the account. Returns empty string for bots. Returns empty string if user is offline / server allow anonymous users / user is not logged in. More...

abstract int	TotalGames `[get]`
	Gets score for total games. More...

abstract int	TotalWins `[get]`
	Gets score for total wins. More...

abstract int	TotalLosses `[get]`
	Gets score for total losses. More...

abstract void	IncreaseScore ()
	Increases the TotalWins score for this user when the game is over (and doesn't count towards TotalLosses). More...

abstract PlayerTeam	GetTeam ()
	Gets the player team. If this user isn't controlling any player the team assigned in the lobby will be returned. More...

abstract bool	IsBot `[get]`
	*‍/ More...

abstract PredefinedAIType	BotPredefinedAIType `[get]`
	Gets the predefinedAIType used by bot users. More...

abstract bool	IsUser `[get]`
	Gets if this user is controlled by a real user. More...

abstract IPlayer	GetPlayer ()
	*‍/ More...

abstract void	SetPlayer (IPlayer player, bool flash=true)
	Sets the active player for this user. The user will lose control of any current player the user is controlling. More...

abstract Gender	Gender `[get]`
	Gets the current profile's Gender. More...

abstract IProfile	GetProfile ()
	Gets the user's profile. More...

abstract bool	IsRemoved `[get]`
	Gets is this user is removed from the game and no longer active. More...

Detailed Description

Access to certain information and functions about a user.

Member Function Documentation

◆ GetPlayer()

abstract IPlayer GetPlayer ( )

pure virtual

*‍/

Gets the current player this user is controlling if any. Can be null.

Returns

◆ GetProfile()

abstract IProfile GetProfile ( )

pure virtual

Gets the user's profile.

Returns

◆ GetTeam()

abstract PlayerTeam GetTeam ( )

pure virtual

Gets the player team. If this user isn't controlling any player the team assigned in the lobby will be returned.

◆ IncreaseScore()

abstract void IncreaseScore ( )

pure virtual

Increases the TotalWins score for this user when the game is over (and doesn't count towards TotalLosses).

◆ SetPlayer()

abstract void SetPlayer	(	IPlayer	player,
		bool	flash = `true`
	)

pure virtual

Sets the active player for this user. The user will lose control of any current player the user is controlling.

Parameters

player	Player to let the user control.
flash	If the player should flash when the new user is assigned. The flashing is only visible to the user itself.

Property Documentation

◆ AccountID

abstract string AccountID

get

Gets the user's account ID as Superfighters Deluxe will track the account. Returns empty string for bots. Returns empty string if user is offline / server allow anonymous users / user is not logged in.

◆ AccountName

abstract string AccountName

get

Gets the user's account Name as Superfighters Deluxe will track the account. Returns empty string for bots. Returns empty string if user is offline / server allow anonymous users / user is not logged in.

◆ BotPredefinedAIType

abstract PredefinedAIType BotPredefinedAIType

get

Gets the predefinedAIType used by bot users.

◆ ConnectionIP

abstract string ConnectionIP

get

Gets the user's connection IP if the game is running in a server. Returns empty string for bots. Returns "localhost" for players playing on the same computer as the server.

◆ GameSlotIndex

abstract int GameSlotIndex

get

Gets the game slot index (lobby slot index) this user occupies. Returns -1 for users not connected to any game slot (for example auto created bots in certain situations).

◆ Gender

abstract Gender Gender

get

Gets the current profile's Gender.

◆ IsBot

abstract bool IsBot

get

*‍/

Gets if this user is controlled by a bot. It's the bot assigned in the lobby. This will activate a predefined AI for the player upon spawning.

◆ IsHost

abstract bool IsHost

get

Gets if this is the host.

◆ IsModerator

abstract bool IsModerator

get

Gets if this user is a moderator.

◆ IsRemoved

abstract bool IsRemoved

get

Gets is this user is removed from the game and no longer active.

*‍/

◆ IsUser

abstract bool IsUser

get

Gets if this user is controlled by a real user.

◆ JoinedAsSpectator

abstract bool JoinedAsSpectator

get

Gets if this user joined as a spectator. Spectators will not interact with the game other than chatting. Note: Currently not possible to join as a spectator but may be in the future.

◆ Name

abstract string Name

get

Gets the name of the user. This is the user's in-game character name.

Returns: Name of the user's character.

◆ Ping

abstract int Ping

get

Gets the ping (Average roundtrip time in ms to the server as the server sees it).

◆ Spectating

abstract bool Spectating

get

Gets if the user is currently spectating. This is true while a recently connected user is waiting for the next round.

◆ TotalGames

abstract int TotalGames

get

Gets score for total games.

◆ TotalLosses

abstract int TotalLosses

get

Gets score for total losses.

◆ TotalWins

abstract int TotalWins

get

Gets score for total wins.

◆ UserIdentifier

abstract int UserIdentifier

get

Gets the unique user identifier.