🏆Rank
Classes
Typedefs
CanvacardRankData : object
Rank
Kind: global class
.build(ops) ⇒
Promise.<Buffer>
new Rank()
Creates Rank card
Example
rank.data : CanvacardRankData
CanvacardRankData
Rank card data
Kind: instance property of Rank
\
rank.renderEmojis([apply]) ⇒ Rank
Rank
Si debe mostrar el nombre de usuario con emojis (si los hay)
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
[apply] |
|
| Establécelo a |
rank.setFontSize(size) ⇒ Rank
Rank
Tamaño de letra
Kind: instance method of Rank
Param | Type |
---|---|
size |
|
rank.setUsername(name, color) ⇒ Rank
Rank
Establecer nombre de usuario
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
name |
| Username | |
color |
|
| Username color |
rank.setProgressBar(color, [fillType], [rounded]) ⇒ Rank
Rank
Definir el estilo de la barra de progreso
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
color |
| Progressbar Color | |
[fillType] |
|
| Progressbar type |
[rounded] |
|
| If progressbar should have rounded edges |
rank.setProgressBarTrack(color) ⇒ Rank
Rank
Fijar la pista de la barra de progreso
Kind: instance method of Rank
Param | Type | Description |
---|---|---|
color |
| Track color |
rank.setOverlay(color, [level], [display]) ⇒ Rank
Rank
Establecer superposición de tarjetas
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
color |
| Overlay color | |
[level] |
|
| Opacity level |
[display] |
|
| IF it should display overlay |
rank.setRequiredXP(data, color) ⇒ Rank
Rank
Establecer xp requerido
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
data |
| Required xp | |
color |
|
| Color |
rank.setCurrentXP(data, color) ⇒ Rank
Rank
Fijar xp actual
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
data |
| Current xp | |
color |
|
| Color |
rank.setRank(data, text, [display]) ⇒ Rank
Rank
Establecer rango
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
data |
| Current Rank | |
text |
|
| Display text |
[display] |
|
| If it should display rank |
rank.setRankColor(text, number) ⇒ Rank
Rank
Establecer el color de visualización del rango
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
text |
|
| text color |
number |
|
| Number color |
rank.setLevelColor(text, number) ⇒ Rank
Rank
Fijar color de nivel
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
text |
|
| text color |
number |
|
| number color |
rank.setLevel(data, text, [display]) ⇒ Rank
Rank
Establecer nivel
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
data |
| Current Level | |
text |
|
| Display text |
[display] |
|
| If it should display level |
rank.setCustomStatusColor(color) ⇒ Rank
Rank
Establecer color de estado personalizado
Kind: instance method of Rank
Param | Type | Description |
---|---|---|
color |
| Color to set |
rank.setStatus(status, circle, width) ⇒ Rank
Rank
Establecer estado
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
status |
| User status | |
circle |
|
| Si el icono de estado debe ser circular. |
width |
|
| Anchura de estado |
rank.setBackground(type, [data]) ⇒ Rank
Rank
Establecer imagen/color de fondo
Kind: instance method of Rank
Param | Type | Description |
---|---|---|
type |
| Background type |
[data] |
| Background color or image |
rank.setAvatar(data) ⇒ Rank
Rank
Avatar de usuario
Kind: instance method of Rank
Param | Type | Description |
---|---|---|
data |
| Avatar data |
rank.build(ops) ⇒ Promise.<Buffer>
Promise.<Buffer>
Construye la tarjeta de rango
Kind: instance method of Rank
Param | Type | Default | Description |
---|---|---|---|
ops |
| Fonts | |
[ops.fontX] |
|
| Bold font family |
[ops.fontY] |
|
| Regular font family |
CanvacardRankData : object
object
Kind: global typedef Properties
Name | Type | Default | Description |
---|---|---|---|
width |
| Ancho de la tarjeta de rango | |
height |
| Altura de la tarjeta de rango | |
background |
| Datos de antecedentes de la tarjeta de rango | |
[background.type] |
|
| Tipo de fondo |
[background.image] |
|
| Imagen de fondo (o color) |
progressBar |
| Datos de la barra de progreso | |
[progressBar.rounded] |
|
| Si la barra de progreso debe redondearse |
[progressBar.x] |
|
| Barra de progreso X |
[progressBar.y] |
|
| Barra de progreso Y |
[progressBar.height] |
|
| Altura de la barra de progreso |
[progressBar.width] |
|
| Ancho de la barra de progreso |
[progressBar.track] |
| Pista de la barra de progreso | |
[progressBar.track.color] |
|
| Color de la pista de la barra de progreso |
[progressBar.bar] |
| Datos de la barra de progreso | |
[progressBar.bar.type] |
|
| Tipo de barra de progreso |
[progressBar.bar.color] |
|
| Color de la barra de la barra de progreso |
overlay |
| Superposición de la barra de progreso | |
[overlay.display] |
|
| Si debería mostrar superposición |
[overlay.level] |
|
| Nivel de opacidad de superposición |
[overlay.color] |
|
| Superposición de color de fondo |
avatar |
| Datos de avatar de la tarjeta de rango | |
[avatar.source] |
|
| Fuente de avatar |
[avatar.x] |
|
| X |
[avatar.y] |
|
| Y |
[avatar.height] |
|
| altura |
[avatar.width] |
|
| ancho |
status |
| Estado de la tarjeta de rango | |
[status.width] |
|
| Ancho de estado |
[status.type] |
| Tipo de estado | |
[status.color] |
|
| Color de estado |
[status.circle] |
|
| ¿Estado circular? |
rank |
| Datos de rango de la tarjeta de clasificación | |
[rank.display] |
|
| Si debe mostrar rango |
[rank.data] |
|
| El rango |
[rank.textColor] |
|
| Rango de color del texto |
[rank.color] |
|
| Color de rango |
[rank.displayText] |
|
| Texto de visualización de rango |
level |
| Datos de nivel de tarjeta de rango | |
[level.display] |
|
| Si debería mostrar el nivel |
[level.data] |
|
| El nivel |
[level.textColor] |
|
| color de texto de nivel |
[level.color] |
|
| color de nivel |
[level.displayText] |
|
| texto de visualización de nivel |
previousRankXP |
| tarjeta xp de rango anterior opcional | |
[previousRankXP.data] |
| xp de rango anterior opcional | |
[previousRankXP.color] |
|
| Tabla de rango de color de rango xp anterior opcional |
currentXP |
| Tarjeta de rango xp actual | |
[currentXP.data] |
|
| XP actual |
[currentXP.color] |
|
| Carta de rango color xp actual |
requiredXP |
| Tarjeta de rango requerida xp | |
[requiredXP.data] |
|
| requerido xp |
[requiredXP.color] |
|
| Se requiere tarjeta de rango xp color |
username |
| Datos de nombre de usuario | |
[username.name] |
|
| Nombre de usuario de la tarjeta de clasificación |
[username.color] |
|
| Color de nombre de usuario de la tarjeta de rango |
[renderEmojis] |
|
| Si debería renderizar emojis |
Last updated