PlayerAvatarUriGenerator | Skills GameOn SDK

Returns a URL linking to an avatar. The avatar image must exist as a file at the provided avatarBaseUrl location and consist of a number (no leading zeros) ending with .png. For example, if there are 500 avatar images, the first one will be 0.png and the last one will be 499.png.

Hierarchy

PlayerAvatarUriGenerator

Index

Constructors

constructor

Methods

Constructors

constructor

new PlayerAvatarUriGenerator(config: PlayerAvatarUriGeneratorConfig): PlayerAvatarUriGenerator

- Defined in skills-gameon-sdk/src/player/playerAvatarUriGenerator.ts:16
Creates a new instance of PlayerAvatarUriGenerator

Parameters
- config: PlayerAvatarUriGeneratorConfig
Returns PlayerAvatarUriGenerator

Methods

getFromHash

getFromHash(hash: Buffer): string

- Defined in skills-gameon-sdk/src/player/playerAvatarUriGenerator.ts:64
Selects a consistant avatar using the supplied hash buffer.

Parameters
- hash: Buffer
  
  Buffer which should contain a 32 bit hash of (such as SHA 256) of player's identity.
Returns string

Url of avatar

getFromId

getFromId(id: string | number): string

- Defined in skills-gameon-sdk/src/player/playerAvatarUriGenerator.ts:52
Selects a consistant avatar given an ID.

Parameters
- id: string | number
  
  Identity used to select a constant name.
Returns string

Url of avatar

getRandom

getRandom(): string

- Defined in skills-gameon-sdk/src/player/playerAvatarUriGenerator.ts:41
Returns the URL of a randomly selected avatar.

Returns string

Url of the avatar

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: PlayerAvatarUriGeneratorConfig

Returns PlayerAvatarUriGenerator

Methods

getFromHash

Parameters

hash: Buffer

Returns string

getFromId

Parameters

id: string | number

Returns string

getRandom

Returns string