Skip to content

Module: client/apis/AvatarAPI

Table of contents

Classes

Type aliases

Type aliases

BodyColors

Ƭ BodyColors: object

Type declaration:

Name Type
headColorId number
leftArmColorId number
leftLegColorId number
rightArmColorId number
rightLegColorId number
torsoColorId number

Defined in: client/apis/AvatarAPI.ts:13

BodyScales

Ƭ BodyScales: object

Type declaration:

Name Type
bodyType number
depth number
head number
height number
proportion number
width number

Defined in: client/apis/AvatarAPI.ts:5

ColorPalette

Ƭ ColorPalette: object

Type declaration:

Name Type
brickColorId number
hexColor string
name string

Defined in: client/apis/AvatarAPI.ts:26

CreateOutfit

Ƭ CreateOutfit: object

Type declaration:

Name Type
success boolean

Defined in: client/apis/AvatarAPI.ts:198

CreateOutfitOptions

Ƭ CreateOutfitOptions: Omit<GetOutfit, id | isEditable>

Defined in: client/apis/AvatarAPI.ts:197

DeleteOutfit

Ƭ DeleteOutfit: object

Type declaration:

Name Type
success boolean

Defined in: client/apis/AvatarAPI.ts:186

DeleteOutfitOptions

Ƭ DeleteOutfitOptions: object

Type declaration:

Name Type
userOutfitId number

Defined in: client/apis/AvatarAPI.ts:183

GetAvatarMetadata

Ƭ GetAvatarMetadata: object

Type declaration:

Name Type
areThreeDeeThumbsEnabled boolean
enableDefaultClothingMessage boolean
isAvatarScaleEmbeddedInTab boolean
isBodyTypeScaleOutOfTab boolean
scaleBodyTypeIncrement number
scaleHeadIncrement number
scaleHeightIncrement number
scaleProportionIncrement number
scaleWidthIncrement number
showDefaultClothingMessageOnPageLoad boolean
supportProportionAndBodyType boolean

Defined in: client/apis/AvatarAPI.ts:52

GetAvatarRules

Ƭ GetAvatarRules: object

Type declaration:

Name Type
basicBodyColorsPalette ColorPalette[]
bodyColorsPalette ColorPalette[]
bundlesEnabledForUser boolean
defaultClothingAssetLists object
defaultClothingAssetLists.defaultPantAssetIds number[]
defaultClothingAssetLists.defaultShirtAssetIds number[]
emotesEnabledForUser boolean
minimumDeltaEBodyColorDifference number
playerAvatarTypes (R6 | R15 | string)[]
proportionsAndBodyTypeEnabledForUser boolean
scales object
scales.bodyType Scale
scales.head Scale
scales.height Scale
scales.width Scale
wearableAssetTypes { id: number ; maxNumber: number ; name: string }[]

Defined in: client/apis/AvatarAPI.ts:65

GetOutfit

Ƭ GetOutfit: object

Type declaration:

Name Type
assets { assetType: { id: number ; name: string } ; id: number ; name: string }[]
bodyColors BodyColors
id number
isEditable boolean
name string
playerAvatarType string
scale object
scale.bodyType number
scale.depth number
scale.head number
scale.height number
scale.proportion number
scale.width number

Defined in: client/apis/AvatarAPI.ts:160

GetOutfitOptions

Ƭ GetOutfitOptions: object

Type declaration:

Name Type
userOutfitId number

Defined in: client/apis/AvatarAPI.ts:157

GetRecentItems

Ƭ GetRecentItems: object

Type declaration:

Name Type
data { assetType: { id: number ; name: string } ; id: number ; isEditable: boolean ; name: string ; type: string }[]
total number

Defined in: client/apis/AvatarAPI.ts:204

GetRecentItemsOptions

Ƭ GetRecentItemsOptions: object

Type declaration:

Name Type
recentItemListType All | Clothing | BodyParts | AvatarAnimations | Accessories | Outfits | Gear | string

Defined in: client/apis/AvatarAPI.ts:201

GetUserAvatar

Ƭ GetUserAvatar: UserAvatar

Defined in: client/apis/AvatarAPI.ts:93

GetUserAvatarOptions

Ƭ GetUserAvatarOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/AvatarAPI.ts:90

GetUserCurrentlyWearing

Ƭ GetUserCurrentlyWearing: object

Type declaration:

Name Type
assetIds number[]

Defined in: client/apis/AvatarAPI.ts:97

GetUserCurrentlyWearingOptions

Ƭ GetUserCurrentlyWearingOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/AvatarAPI.ts:94

GetUserOutfits

Ƭ GetUserOutfits: object

Type declaration:

Name Type
data { id: number ; isEditable: boolean ; name: string }[]
filteredCount number
total number

Defined in: client/apis/AvatarAPI.ts:106

GetUserOutfitsOptions

Ƭ GetUserOutfitsOptions: object

Type declaration:

Name Type
isEditable? boolean
itemsPerPage? number
page? number
userId number

Defined in: client/apis/AvatarAPI.ts:100

RedrawThumbnail

Ƭ RedrawThumbnail: unknown

Defined in: client/apis/AvatarAPI.ts:127

RemoveAssetFromAvatar

Ƭ RemoveAssetFromAvatar: object

Type declaration:

Name Type
success boolean

Defined in: client/apis/AvatarAPI.ts:118

RemoveAssetFromAvatarOptions

Ƭ RemoveAssetFromAvatarOptions: object

Type declaration:

Name Type
assetId number

Defined in: client/apis/AvatarAPI.ts:115

Scale

Ƭ Scale: object

Type declaration:

Name Type
increment number
max number
min number

Defined in: client/apis/AvatarAPI.ts:21

SetBodyColors

Ƭ SetBodyColors: object

Type declaration:

Name Type
success boolean

Defined in: client/apis/AvatarAPI.ts:129

SetBodyColorsOptions

Ƭ SetBodyColorsOptions: BodyColors

Defined in: client/apis/AvatarAPI.ts:128

SetPlayerAvatarScales

Ƭ SetPlayerAvatarScales: object

Type declaration:

Name Type
success boolean

Defined in: client/apis/AvatarAPI.ts:139

SetPlayerAvatarScalesOptions

Ƭ SetPlayerAvatarScalesOptions: BodyScales

Defined in: client/apis/AvatarAPI.ts:138

SetPlayerAvatarType

Ƭ SetPlayerAvatarType: object

Type declaration:

Name Type
success boolean

Defined in: client/apis/AvatarAPI.ts:135

SetPlayerAvatarTypeOptions

Ƭ SetPlayerAvatarTypeOptions: object

Type declaration:

Name Type
playerAvatarType R6 | R15 | string

Defined in: client/apis/AvatarAPI.ts:132

SetPlayerAvatarWearingAssets

Ƭ SetPlayerAvatarWearingAssets: object

Type declaration:

Name Type
invalidAssetIds? number[]
invalidAssets? { assetType: { id: number ; name: string } ; id: number ; name: string }[]
success boolean

Defined in: client/apis/AvatarAPI.ts:145

SetPlayerAvatarWearingAssetsOptions

Ƭ SetPlayerAvatarWearingAssetsOptions: object

Type declaration:

Name Type
assetIds number[]

Defined in: client/apis/AvatarAPI.ts:142

UpdateOutfit

Ƭ UpdateOutfit: object

Type declaration:

Name Type
success boolean

Defined in: client/apis/AvatarAPI.ts:190

UpdateOutfitOptions

Ƭ UpdateOutfitOptions: Omit<GetOutfit, isEditable>

Defined in: client/apis/AvatarAPI.ts:189

UserAvatar

Ƭ UserAvatar: object

Type declaration:

Name Type
assets { assetType: { id: number ; name: string } ; id: number ; name: string }[]
bodyColors BodyColors
defaultPantsApplied boolean
defaultShirtApplied boolean
emotes { assetId: number ; assetName: string ; position: number }[]
playerAvatarType R6 | R15 | string
scales BodyScales

Defined in: client/apis/AvatarAPI.ts:32

WearAssetOnAvatar

Ƭ WearAssetOnAvatar: object

Type declaration:

Name Type
success boolean

Defined in: client/apis/AvatarAPI.ts:124

WearAssetOnAvatarOptions

Ƭ WearAssetOnAvatarOptions: object

Type declaration:

Name Type
assetId number

Defined in: client/apis/AvatarAPI.ts:121

WearOutfit

Ƭ WearOutfit: SetPlayerAvatarWearingAssets

Defined in: client/apis/AvatarAPI.ts:196

WearOutfitOptions

Ƭ WearOutfitOptions: object

Type declaration:

Name Type
userOutfitId number

Defined in: client/apis/AvatarAPI.ts:193