Skip to content

Commit 98ad026

Browse files
committed
Update script and atcommand documentation
1 parent 95d6f76 commit 98ad026

File tree

2 files changed

+32
-14
lines changed

2 files changed

+32
-14
lines changed

doc/atcommands.txt

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -560,9 +560,9 @@ Using the command without a message will enable or disable main chat.
560560

561561
---------------------------------------
562562

563-
@storage
563+
@storage <storage name/id>
564564

565-
Opens your Kafra storage.
565+
Opens your specified Kafra storage.
566566

567567
---------------------------------------
568568

@@ -731,9 +731,9 @@ Valid item types:
731731

732732
---------------------------------------
733733

734-
@storeall
734+
@storeall <storage name/id>
735735

736-
Places all inventory and equipped items directly into your Kafra Storage.
736+
Places all inventory and equipped items directly into your specified storage.
737737

738738
---------------------------------------
739739

@@ -743,10 +743,15 @@ Deletes all inventory items (not equipped items).
743743

744744
---------------------------------------
745745

746-
@clearstorage
746+
@clearstorage <storage name/id>
747+
748+
Deletes all items in specified storage.
749+
750+
---------------------------------------
751+
747752
@cleargstorage
748753

749-
Deletes all items in storage (or guild storage).
754+
Deletes all items in guild storage.
750755

751756
---------------------------------------
752757

doc/script_commands.txt

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6217,19 +6217,32 @@ has no gear, script will be terminated with an error.
62176217
//=====================================
62186218
---------------------------------------
62196219

6220-
*openstorage()
6220+
*openstorage(<storage_constant>{, <storage_mode>});
62216221

6222-
This will open character's Kafra storage window on the client connected to
6223-
the invoking character. It can be used from any kind of NPC or item
6224-
script, not just limited to Kafra Staff.
6222+
This command opens the specified storage window <storage_id> on the client
6223+
connected to the invoking character. It can be used from any kind of NPC or
6224+
item script and is not limited to Kafra Staff interactions.
62256225

6226-
The storage window opens regardless of whether there are open NPC dialogs
6227-
or not, but it is preferred to close the dialog before displaying the
6228-
storage window, to avoid any disruption when both windows overlap.
6226+
The storage window will open regardless of whether there are open NPC dialogs,
6227+
but it is recommended to close any dialogs before displaying the storage window
6228+
to avoid overlapping interface elements, which could disrupt the user experience.
62296229

6230+
Parameters:
6231+
<storage_constant>: Specifies which storage to open (e.g., STORAGE_TYPE_MAIN).
6232+
Constants are declared in conf/storage.conf
6233+
<storage_mode> (optional): Defines the access permissions for the storage window.
6234+
6235+
Storage Modes (bitmask):
6236+
STORAGE_ACCESS_VIEW: View storage only.
6237+
STORAGE_ACCESS_GET: Allow retrieving items from storage.
6238+
STORAGE_ACCESS_PUT: Allow depositing items into storage.
6239+
STORAGE_ACCESS_ALL: (Default mode) Full access for viewing, retrieving,
6240+
and depositing items.
6241+
6242+
Example Usage:
62306243
mes("I will now open your stash for you");
62316244
close2();
6232-
openstorage();
6245+
openstorage(STORAGE_TYPE_MAIN);
62336246
end;
62346247

62356248
The mapflag 'nostorage' when set to type '2' (or 3), will not open the

0 commit comments

Comments
 (0)