https://github.com/jingshing/fvtt-transformitemtutorial

a macro tutorial help making item transform effect.
https://github.com/jingshing/fvtt-transformitemtutorial

Last synced: 5 months ago
JSON representation

a macro tutorial help making item transform effect.

• Host: GitHub
• URL: https://github.com/jingshing/fvtt-transformitemtutorial
• Owner: JingShing
• License: bsd-3-clause
• Created: 2024-09-03T13:05:57.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-04T13:12:19.000Z (almost 2 years ago)
• Last Synced: 2025-06-23T00:07:16.190Z (about 1 year ago)
• Language: JavaScript
• Size: 5.91 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
English | [繁體中文](README_TCH.md)

# FoundryVTT Item Transform Macro Tutorial

## Example

### Scriptable Items

![example](img/example.gif)

### Scriptable Items with dialog

![button_dialog](img/button_dialog.png)

![dialog_select](img/dialog_select.png)

### Dynamic Active Effects

![example_dae](img/example_dae.gif)

## Module-Optional

* [Scriptable Items](https://foundryvtt.com/packages/scriptable-items)

* [Dynamic Active Effects](https://foundryvtt.com/packages/dae)

## Base Script

> If you don't want to use module to do it

### add item to actor

```js

// get a actor called test

let test =game.actors.getName("test");

// get item id called XD3kQ0JxvPDamH2m

let testitem=game.items.get("XD3kQ0JxvPDamH2m");

// add item to actor

test.createEmbeddedDocuments("Item", [testitem.toObject()])

```

### delete item from actor

```js

// get item in actor

let item;

// using delete function to removed item from actor

item.delete();

```

### get item from compendium

```js

// id format: Compendium.dnd5e_classpack.itempack.Item.A8FA9E9D797EC9FB

// removed Compendium

// dnd5e_classpack.itempack is pack id

// A8FA9E9D797EC9FB is item id

// first get pack

let testPack = game.packs.get("dnd5e_classpack.itempack");

// then use id to find item

let testItem = await testPack.getDocument("A8FA9E9D797EC9FB");

```

## With module-Scriptable Items

### Reference

[scriptable Items Instruction](https://github.com/FurtherV/scriptable-items)

### How to setup

* Create item

* Click "scriptable item" button on top

  * ![script_item](img/script_item.png)

* It will open a edit page

  * ![edit](img/edit.png)

* add triggers with button

  * ![button](img/button.png)

* add script

  * ![add_script](img/add_script.png)

### Script

```js

// get actor

let cActor = actor;

// item you wanna transform

let giveItem=game.items.get("B1QGodNijs2Ro5Ie");

// add item to actor

cActor.createEmbeddedDocuments("Item", [giveItem.toObject()])

// delete chat room button message generated from this script

optional.message.delete();

// remove original item

item.delete();

```

## With module using dialog-Scriptable Items

Using "Scriptable Items" setup.

Change the script;

### Script

```js

new Dialog({

  // put menu title here

  title: "Transform select menu",

  // put instruction in here

  content: "This is transfrom instructions",

  // setting buttons also selection in below

  buttons: {

    button1: {

      // this is button called "A"

      label: "A",

      callback: () => {

      // put code give item, select item and delete message in here

      // here is how button work so just put code in here area

)},

      // setting icon here

      icon: ``

    },

    button2: {

      label: "B",

      callback: () => {

},

      icon: ``

    }

  }

}).render(true);

```

## With module-Dynamic Active Effects

### Reference

[Dynamic Active Effects Instruction](https://gitlab.com/tposney/dae)

### How to setup

* Create item

  * ![itemPage](img/ItemPage.png)

* Click "active effect" button on top

  * ![effect_page](img/activeEffect.png)

* setting effect pause and transfer effect to actor, and your effect name

  * Especially effect name as my script is based on effect name

  * ![edit_effect](img/effect_set.png)

* setting effect attribute to ```macro.itemMacro```

  * ![edit_effect2](img/effect_set_2.png)

* add script

  * back to item page click "DIME" button on top

  * ![DIME](img/DIME.png)

### Script

```js

// when effect turn on it trigger

if(args[0]=="on"){

// get last args-> last args contains multiple args we need

let cArgs = args[args.length-1];

// get actor equipped or held item

let cActor = fromUuidSync(cArgs.actorUuid);

// get item triggered effect

let cItem = cArgs.item;

// get effect name

let cEfName = cArgs.efData.name;

let giveItemId = "";

// if effect name called "A"

// then item will be transform into itemA

if(cEfName==="A"){

// get itemA id and replace it

giveItemId="itemAid";

}

if(cEfName==="B"){

giveItemId="itemBid";

}

// if get right effect name then give player item and delete triggered item

if(giveItemId!==""){

// get transfromed item

let giveItem=game.items.get(giveItemId);

// add item to actor

cActor.createEmbeddedDocuments("Item", [giveItem.toObject()])

// removed original item

cItem .delete();

}

}

```