FivePD API
Models

User

Represents the 'users' table.

This model represents the database table fivepd_users. When modifying any properties of this model, ensure that you have saved the changes using the DatabaseContext.

Methods

HasRole

Gets whether the user has the specified role.

Parameters

NameTypeDescription
roleUserRoleThe role you want to check.

Returns

NameType
boolA boolean.

Properties

Id

Gets or sets the identifier.

Type: int

AccessFivePD

Gets or sets a value indicating whether this player has access to use FivePD or not.

Type: bool

PreferredLanguage

Gets or sets the preferred language of the user.

Type: string

FirstLogin

Gets or sets a value indicating whether the user is playing for the first time.

Type: bool

DismissedWelcomeMessage

Gets or sets a value indicating whether the user has dismissed the welcome message.

Type: bool

Name

Gets or sets the name.

Type: string

IdentifierLicense

Gets or sets the License identifier.

Type: string

IdentifierDiscord

Gets or sets the Discord identifier.

Type: string

IdentifierSteam

Gets or sets the Steam identifier.

Type: string

IdentifierXbl

Gets or sets the Xbl identifier.

Type: string

IdentifierLive

Gets or sets the Xbox live identifier.

Type: string

Xp

Gets or sets the experience points.

Type: int

AudioVolume

Gets or sets the volume of the audio, played via the IAudioService.

Type: double

Role

Gets or sets the role of the user.

Type: int

Callsign

Gets or sets the callsign.

Type: string

CallsignFormat

Gets or sets the user callsign.

Type: UserCallsignFormat

Department

Gets or sets the department which the user is joined to.

Type: Department

Division

Gets or sets the division which the user is joined to.

Type: Division

Rank

Gets or sets the rank.

Type: Rank

FixedRank

Gets or sets a value indicating whether the rank can be increased or decreased by the progression system. Enable this if you want to keep the rank of the user.

Type: bool

Messages

Gets or sets the messages sent to the user.

Type: IList<Message>