Class Player

Players, as far as the Chat System is concerned. Contains list of subscribed channels, blocked players, name, connection id, and isOnline status

Inheritance

System.Object

Player

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: LlamaSoftware.Chat.Model

Assembly: LlamaSoftware.Chat.Model.dll

Syntax

[Serializable]
public class Player

Constructors

Player(Int32, String, String)

Declaration

public Player(int ConnectionId, string PlayerId, string Name)

Parameters

Type	Name	Description
System.Int32	ConnectionId
System.String	PlayerId
System.String	Name

Player(Int32, String, String, List<ChatChannel>)

Declaration

public Player(int ConnectionId, string PlayerId, string Name, List<ChatChannel> ChatChannels)

Parameters

Type	Name	Description
System.Int32	ConnectionId
System.String	PlayerId
System.String	Name
System.Collections.Generic.List<ChatChannel>	ChatChannels

Player(Int32, String, String, List<ChatChannel>, List<SocialPlayer>)

Declaration

public Player(int ConnectionId, string PlayerId, string Name, List<ChatChannel> ChatChannels, List<SocialPlayer> Friends)

Parameters

Type	Name	Description
System.Int32	ConnectionId
System.String	PlayerId
System.String	Name
System.Collections.Generic.List<ChatChannel>	ChatChannels
System.Collections.Generic.List<SocialPlayer>	Friends

Player(Int32, String, String, List<ChatChannel>, List<SocialPlayer>, List<SocialPlayer>)

Declaration

public Player(int Connectionid, string PlayerId, string Name, List<ChatChannel> ChatChannels, List<SocialPlayer> Friends, List<SocialPlayer> BlockedPlayers)

Parameters

Type	Name	Description
System.Int32	Connectionid
System.String	PlayerId
System.String	Name
System.Collections.Generic.List<ChatChannel>	ChatChannels
System.Collections.Generic.List<SocialPlayer>	Friends
System.Collections.Generic.List<SocialPlayer>	BlockedPlayers

Properties

BlockedPlayers

List of player whom are blocked by this player

Declaration

public List<SocialPlayer> BlockedPlayers { get; }

Property Value

Type	Description
System.Collections.Generic.List<SocialPlayer>

ConnectionId

Active

Declaration

public int ConnectionId { get; }

Property Value

Type	Description
System.Int32

Friends

List of players this player has added as friends

Declaration

public List<SocialPlayer> Friends { get; }

Property Value

Type	Description
System.Collections.Generic.List<SocialPlayer>

IsOnline

If the player is currently online

Declaration

public bool IsOnline { get; set; }

Property Value

Type	Description
System.Boolean

Name

Display name of the player

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

PlayerId

Unique id of the player. Must be globally unique. Something like could work.

Declaration

public string PlayerId { get; }

Property Value

Type	Description
System.String

SubscribedChatChannels

List of currently available ChatChannels

Declaration

public List<ChatChannel> SubscribedChatChannels { get; }

Property Value

Type	Description
System.Collections.Generic.List<ChatChannel>

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()