Module: profile

Members

(inner, constant) LOCAL_PROFILE_IMAGE_STANDARD_URLS :Record.<module:profile~ProfileImageName, string>

Type:
Source:

Methods

(static) createProfileObject() → {Types.ClientToServerProfile}

Source:
Returns:
object containing locally saved profile data
Type
Types.ClientToServerProfile

(static) getIsMute() → {boolean}

Fetches mute setting from browser's local storage
Source:
Returns:
saved mute status; true if muted and false otherwise
Type
boolean

(static) getMusicVolumeLevel() → {number}

Fetches current music volume from browser's local storage
Source:
Returns:
currently saved music volume in range [0, 1]
Type
number

(static) getPlayerUUID() → {Types.UUID}

Fetches previously-set player UUID from browser's session storage; UUID will be invalid if fetched after game instance has ended
Source:
Returns:
last UUID sent from the server to the client
Type
Types.UUID

(static) getProfileImageName() → {module:profile~ProfileImageName}

Fetches name of profile image from browser's local storage
Source:
Returns:
name of profile image selected
Type
module:profile~ProfileImageName

(static) getProfileImageNameOptions() → {Array.<module:profile~ProfileImageName>}

Fetches list of existing profile image name options; used to populate list of available options in settings menu
Source:
Returns:
list of names that can be selected by user
Type
Array.<module:profile~ProfileImageName>

(static) getProfileImageUrl() → {string}

Fetches profile image url from browser's local storage
Source:
Returns:
file path to saved user profile image
Type
string

(static) getProfileImageUrlFromName(profileImageName) → {string}

Converts name of a profile image to an actual url; used to populate option lists in settings menu or pick url for opponent's icon in versus mode
Parameters:
Name Type Description
profileImageName module:profile~ProfileImageName name of profile image, custom excluded
Source:
Returns:
url to profile image
Type
string

(static) getSFXVolumeLevel() → {number}

Fetches current special effects volume from browser's local storage
Source:
Returns:
currently saved SFX volume in range [0, 1]
Type
number

(static) getUsername() → {string}

Fetches username from browser's local storage
Source:
Returns:
saved username
Type
string

(static) setIsMute(isMute) → {boolean}

Saves mute setting to local storage for access across sessions
Parameters:
Name Type Description
isMute boolean true if volume should be muted; otherwise false
Source:
Returns:
true if saved successfully; otherwise false
Type
boolean

(static) setMusicVolumeLevel(volumeLevel) → {boolean}

Saves music volume level setting to local storage for access across sessions
Parameters:
Name Type Description
volumeLevel number volume level in range [0, 1]
Source:
Returns:
true if saved successfully; false otherwise
Type
boolean

(static) setPlayerUUID(playerUUID) → {boolean}

Attaches UUID sent from server to profile instance by saving it to browser's session storage; UUIDs are set on a per-instance basis
Parameters:
Name Type Description
playerUUID Types.UUID UUID sent from server
Source:
Returns:
true if saved successfully; otherwise false
Type
boolean

(static) setProfileImage(profileImageName, optionsopt) → {boolean}

Saves valid profile image name, or custom (data) url, to local storage for access across sessions
Parameters:
Name Type Attributes Description
profileImageName module:profile~ProfileImageName name of profile image, or custom flag if customUrl passed
options Object <optional>
 customUrl corresponding to path if custom flag set
Source:
Returns:
true if saved successfully; otherwise false
Type
boolean

(static) setSFXVolumeLevel(volumeLevel) → {boolean}

Saves special effects volume level setting to local storage for access across sessions
Parameters:
Name Type Description
volumeLevel number volume level in range [0, 1]
Source:
Returns:
true if saved successfully; false otherwise
Type
boolean

(static) setUsername(username) → {boolean}

Saves valid username to local storage for access across sessions
Parameters:
Name Type Description
username string valid (nonempty) username
Source:
Returns:
true if saved successfully; otherwise false
Type
boolean

Type Definitions

ProfileImageName

Type:
  • 'default' | 'duck' | 'elephant' | 'fox' | 'lion' | 'walrus' | LOCAL_PROFILE_IMAGE_CUSTOM_FLAG
Source: