From 942a030afd348ab2e02eac8054b43e3c3a72ea48 Mon Sep 17 00:00:00 2001
From: chai <chaifix@163.com>
Date: Mon, 15 Nov 2021 13:53:59 +0800
Subject: *rename

---
 .../Libraries/lua-addons/addons/send/readme.md     | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 Data/BuiltIn/Libraries/lua-addons/addons/send/readme.md

(limited to 'Data/BuiltIn/Libraries/lua-addons/addons/send/readme.md')

diff --git a/Data/BuiltIn/Libraries/lua-addons/addons/send/readme.md b/Data/BuiltIn/Libraries/lua-addons/addons/send/readme.md
new file mode 100644
index 0000000..e77c79f
--- /dev/null
+++ b/Data/BuiltIn/Libraries/lua-addons/addons/send/readme.md
@@ -0,0 +1,28 @@
+## Usage
+
+```
+//send <target> <command>
+```
+
+The target can be the receiver's name, `@all` to send to all instances, `@other` to send to all instances excluding the sender or `@<job>` to send to a specific job. The command can be any valid FFXI or Windower command.
+
+Examples:
+```
+//send @all /ma "Blizzard" <t>
+
+//send @whm /ma "Haste" <me>
+
+//send Mymule //reload timers
+```
+
+## Sending entity IDs
+
+Entity IDs can be sent to the receiver by appending `id` to a target specifier, like `<tid>` for the target's ID. This works not just for `<tid>` but for all common targets mentioned [here](https://github.com/Windower/Lua/wiki/FFXI-Functions#windowerffxiget_mob_by_targettarget), i.e. `<laststid>`, `<meid`, etc. To be able to use in-game actions with target IDs like that requires GearSwap to be loaded on the receiver's end.
+
+Examples:
+```
+//send Mymule /ma "Stun" <tid>
+
+/ta <stnpc>
+//send Mymule /ma "Blizzard" <laststid>
+```
-- 
cgit v1.1-26-g67d0