Mirroristas/rathena
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc update (#7517)

Browse Source 
* Updated the description of instance_id and getitemname script commands
This commit is contained in:
Atemo 2023-01-03 20:55:55 +01:00 committed by GitHub
parent 1361e9c1df
commit 936abe13eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/script_commands.txt
View File

@ -2731,7 +2731,7 @@ See 'getequipid' for a full list of valid equipment slots.
Given the database ID number of an item, this function will return the text
stored in the 'Name' field in item_db_*.yml for text version
or 'name_english' field for SQL version.
or 'name_english' field for SQL version. The function returns "null" if the item doesn't exist.
---------------------------------------
@ -9670,9 +9670,13 @@ returns an empty string instead.
*instance_id({<instance mode>})
Returns the unique instance ID of the given mode. By default it returns the
attached script instance. If <instance mode> is provided then the instance
of the currently attached player is used. If that fails, the function will return 0.
Returns the unique instance ID of the given mode.
By default (no parameter given) the command returns the instance ID from the attached NPC.
If <instance mode> is provided the instance ID of the currently attached player is returned.
If that fails, the function will return 0.
Please note that the command always requires the parameter <instance mode> to get the instance ID of an attached player!
Instance Mode options:
IM_CHAR: Attached to character.
@ -9680,6 +9684,13 @@ Instance Mode options:
IM_GUILD: Attached to character's guild.
IM_CLAN: Attached to character's clan.
Examples:
// Example with an attached player :
npctalk "The current instance ID (mode party) from the attached player is : " + instance_id(IM_PARTY);
// Example with an attached NPC on an instance map :
npctalk "The current instance ID from the attached NPC is : " + instance_id();
---------------------------------------
*instance_warpall "<map name>",<x>,<y>{,<instance id>};