# Ship Card

## 🐈‍⬛ Canvafy Design;

<figure><img src="https://1203280867-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQ8KI56rkXEQp2Ao9aeTJ%2Fuploads%2Ff5YHP2iRHm3HTYCHbrsm%2Fship.png?alt=media&#x26;token=42b3bf1e-62cb-4b58-8446-36483e947a1c" alt=""><figcaption></figcaption></figure>

```javascript
await new canvafy.Ship()
```

## [.setAvatars(imageURLOne,imageURLTwo)](#.setavatars-imageurlone-imageurltwo)

<table><thead><tr><th>PARAMETER</th><th>TYPE</th><th>DESCRIPTION</th><th data-hidden></th><th data-hidden></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>imageURLOne</strong></mark></td><td><mark style="color:red;"><strong>String</strong></mark></td><td><strong>Setting First User Avatar</strong></td><td></td><td></td></tr><tr><td><mark style="color:blue;"><strong>imageURLTwo</strong></mark></td><td><mark style="color:red;"><strong>String</strong></mark></td><td><strong>Setting Second User Avatar</strong></td><td></td><td></td></tr></tbody></table>

## [.setBackground(type,source)](#.setbackground-image-imageurl)

| PARAMETER                                   | TYPE                                       | DESCRIPTION                             |
| ------------------------------------------- | ------------------------------------------ | --------------------------------------- |
| <mark style="color:blue;">**type**</mark>   | <mark style="color:red;">**String**</mark> | **"image" or "color" adjustment**       |
| <mark style="color:blue;">**source**</mark> | <mark style="color:red;">**String**</mark> | **"imageURL" or "hexColor" adjustment** |

## [.setBorder(color)](#.setborder-color)

| PARAMETER                                  | TYPE                                       | DESCRIPTION                                                                                                                                         |
| ------------------------------------------ | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| <mark style="color:blue;">**color**</mark> | <mark style="color:red;">**String**</mark> | <p><strong>"hexColor" adjustment</strong><br><mark style="background-color:purple;"><strong>(</strong>Preferred Option<strong>)</strong></mark></p> |

## [.setOverlayOpacity(opac)](#.setoverlayopacity-opac)

| PARAMETER                                 | TYPE                                                   | DESCRIPTION             |
| ----------------------------------------- | ------------------------------------------------------ | ----------------------- |
| <mark style="color:blue;">**opac**</mark> | <mark style="color:yellow;">**Number / Double**</mark> | **Transparent Opacity** |

## [.setCustomNumber(number)](#.setcustomnumber-number)

| PARAMETER                                   | TYPE                                          | DESCRIPTION                                                                                                                                      |
| ------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| <mark style="color:blue;">**number**</mark> | <mark style="color:yellow;">**Number**</mark> | <p><strong>Custom Ship Number</strong><br><mark style="background-color:purple;"><strong>(</strong>Preferred Option<strong>)</strong></mark></p> |

## [.build()](#.build)

| PARAMETER                                       | TYPE                                            | DESCRIPTION                                                                                                            |
| ----------------------------------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| ~~<mark style="color:purple;">**None**</mark>~~ | ~~<mark style="color:purple;">**None**</mark>~~ | <p><strong>Image Maker.</strong><br><em><mark style="color:orange;"><strong>❗Required to Use!</strong></mark></em></p> |

### **🌙 Example Of Code With Discord.js v14** <a href="#usage" id="usage"></a>

```javascript
client.on("messageCreate", async message => {
  if (message.content.includes("!ship")) {
   let member = message.mentions.members.first()
   if(!member)return message.reply({content:"Please tag someone.."})

    const ship = await new canvafy.Ship()
    .setAvatars(message.author.displayAvatarURL({ forceStatic: true, extension: "png" }),member.user.displayAvatarURL({ forceStatic: true, extension: "png" }))
    .setBackground("image", "https://th.bing.com/th/id/R.248b992f15fb255621fa51ee0ca0cecb?rik=K8hIsVFACWQ8%2fw&pid=ImgRaw&r=0")
    .setBorder("#f0f0f0")
    .setOverlayOpacity(0.5)
    .build();

    message.reply({
      files: [{
        attachment: ship,
        name: `ship-${message.member.id}.png`
      }]
    });
  }
});
```

## 📃Support Server; [discord.gg/luppux](https://discord.gg/luppux)