# Ship Card

## 🐈‍⬛ Canvafy Design;

<figure><img src="/files/lHqmEAbMTVn8eg5tShsM" 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)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fivesobes.gitbook.io/canvafy/ship-card.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.