diff options
author | Ibrahim Zidan <brahem@aotsw.com> | 2019-05-07 06:37:11 +0200 |
---|---|---|
committer | Ibrahim Zidan <brahem@aotsw.com> | 2019-09-22 23:45:38 +0200 |
commit | 5d7c8d9857f096abfc4f205c8771b0b4c91fab2c (patch) | |
tree | a36b6b0ac2c942e2a18340a715bf256980c1dbec | |
parent | 92f3ecdcb341b798c93d5c8b0320fb8cb85e759c (diff) | |
download | hercules-5d7c8d9857f096abfc4f205c8771b0b4c91fab2c.tar.gz hercules-5d7c8d9857f096abfc4f205c8771b0b4c91fab2c.tar.bz2 hercules-5d7c8d9857f096abfc4f205c8771b0b4c91fab2c.tar.xz hercules-5d7c8d9857f096abfc4f205c8771b0b4c91fab2c.zip |
Implement new script fields for items triggered on rentral status changes
- OnRentalStartScript triggered when a rental item is added to inventory
- OnRentalEndScript triggered when a rental period end/expire of the item
Related #140
Signed-off-by: Ibrahim Zidan <brahem@aotsw.com>
-rw-r--r-- | db/item_db2.conf | 2 | ||||
-rw-r--r-- | db/pre-re/item_db.conf | 2 | ||||
-rw-r--r-- | db/re/item_db.conf | 2 | ||||
-rw-r--r-- | src/map/itemdb.c | 37 | ||||
-rw-r--r-- | src/map/itemdb.h | 2 | ||||
-rw-r--r-- | src/map/pc.c | 19 | ||||
-rw-r--r-- | src/map/script.c | 32 | ||||
-rw-r--r-- | src/map/script.h | 2 |
8 files changed, 93 insertions, 5 deletions
diff --git a/db/item_db2.conf b/db/item_db2.conf index 8a2d8e429..ed673c5ea 100644 --- a/db/item_db2.conf +++ b/db/item_db2.conf @@ -117,6 +117,8 @@ item_db: ( "> OnEquipScript: <" OnEquip Script (can also be multi-line) "> OnUnequipScript: <" OnUnequip Script (can also be multi-line) "> + OnRentalStartScript: <" On item renting script, gets called after item is created in inventory (can also be multi-line) "> + OnRentalEndScript: <" On item rent end/expire script, gets called after item is removed from inventory (can also be multi-line) "> // ================ Optional fields (item_db2 only) =============== Inherit: true/false (boolean, if true, inherit the values that weren't specified, from item_db.conf, diff --git a/db/pre-re/item_db.conf b/db/pre-re/item_db.conf index c860e0239..3fe2fdacd 100644 --- a/db/pre-re/item_db.conf +++ b/db/pre-re/item_db.conf @@ -121,6 +121,8 @@ item_db: ( "> OnEquipScript: <" OnEquip Script (can also be multi-line) "> OnUnequipScript: <" OnUnequip Script (can also be multi-line) "> + OnRentalStartScript: <" On item renting script, gets called after item is created in inventory (can also be multi-line) "> + OnRentalEndScript: <" On item rent end/expire script, gets called after item is removed from inventory (can also be multi-line) "> }, **************************************************************************/ diff --git a/db/re/item_db.conf b/db/re/item_db.conf index 794746784..9f49c07ef 100644 --- a/db/re/item_db.conf +++ b/db/re/item_db.conf @@ -121,6 +121,8 @@ item_db: ( "> OnEquipScript: <" OnEquip Script (can also be multi-line) "> OnUnequipScript: <" OnUnequip Script (can also be multi-line) "> + OnRentalStartScript: <" On item renting script, gets called after item is created in inventory (can also be multi-line) "> + OnRentalEndScript: <" On item rent end/expire script, gets called after item is removed from inventory (can also be multi-line) "> }, **************************************************************************/ diff --git a/src/map/itemdb.c b/src/map/itemdb.c index bb2732b17..204d0ead5 100644 --- a/src/map/itemdb.c +++ b/src/map/itemdb.c @@ -1726,6 +1726,14 @@ static int itemdb_validate_entry(struct item_data *entry, int n, const char *sou script->free_code(entry->unequip_script); entry->unequip_script = NULL; } + if (entry->rental_start_script != NULL) { + script->free_code(entry->rental_start_script); + entry->rental_start_script = NULL; + } + if (entry->rental_end_script != NULL) { + script->free_code(entry->rental_end_script); + entry->rental_end_script = NULL; + } return 0; #if PACKETVER_MAIN_NUM >= 20181121 || PACKETVER_RE_NUM >= 20180704 || PACKETVER_ZERO_NUM >= 20181114 } @@ -1756,6 +1764,14 @@ static int itemdb_validate_entry(struct item_data *entry, int n, const char *sou script->free_code(entry->unequip_script); entry->unequip_script = NULL; } + if (entry->rental_start_script != NULL) { + script->free_code(entry->rental_start_script); + entry->rental_start_script = NULL; + } + if (entry->rental_end_script != NULL) { + script->free_code(entry->rental_end_script); + entry->rental_end_script = NULL; + } return 0; } } @@ -1883,7 +1899,14 @@ static int itemdb_validate_entry(struct item_data *entry, int n, const char *sou script->free_code(item->unequip_script); item->unequip_script = NULL; } - + if (item->rental_start_script != NULL && item->rental_start_script != entry->rental_start_script) { // Don't free if it's inheriting the same script + script->free_code(item->rental_start_script); + item->rental_start_script = NULL; + } + if (item->rental_end_script != NULL && item->rental_end_script != entry->rental_end_script) { // Don't free if it's inheriting the same script + script->free_code(item->rental_end_script); + item->rental_end_script = NULL; + } *item = *entry; return item->nameid; } @@ -1999,6 +2022,8 @@ static int itemdb_readdb_libconfig_sub(struct config_setting_t *it, int n, const * "> * OnEquipScript: <" OnEquip Script "> * OnUnequipScript: <" OnUnequip Script "> + * OnRentalStartScript: <" on renting script "> + * OnRentalEndScript: <" on renting end script "> * Inherit: inherit or override */ if( !itemdb->lookup_const(it, "Id", &i32) ) { @@ -2276,6 +2301,12 @@ static int itemdb_readdb_libconfig_sub(struct config_setting_t *it, int n, const if( libconfig->setting_lookup_string(it, "OnUnequipScript", &str) ) id.unequip_script = *str ? script->parse(str, source, -id.nameid, SCRIPT_IGNORE_EXTERNAL_BRACKETS, NULL) : NULL; + if (libconfig->setting_lookup_string(it, "OnRentalStartScript", &str) != CONFIG_FALSE) + id.rental_start_script = (*str != '\0') ? script->parse(str, source, -id.nameid, SCRIPT_IGNORE_EXTERNAL_BRACKETS, NULL) : NULL; + + if (libconfig->setting_lookup_string(it, "OnRentalEndScript", &str) != CONFIG_FALSE) + id.rental_end_script = (*str != '\0') ? script->parse(str, source, -id.nameid, SCRIPT_IGNORE_EXTERNAL_BRACKETS, NULL) : NULL; + return itemdb->validate_entry(&id, n, source); } @@ -2519,6 +2550,10 @@ static void destroy_item_data(struct item_data *self, int free_self) script->free_code(self->equip_script); if( self->unequip_script ) script->free_code(self->unequip_script); + if (self->rental_start_script != NULL) + script->free_code(self->rental_start_script); + if (self->rental_end_script != NULL) + script->free_code(self->rental_end_script); if( self->combos ) aFree(self->combos); HPM->data_store_destroy(&self->hdata); diff --git a/src/map/itemdb.h b/src/map/itemdb.h index 7da7609f1..d1e5973e8 100644 --- a/src/map/itemdb.h +++ b/src/map/itemdb.h @@ -516,6 +516,8 @@ struct item_data { struct script_code *script; ///< Default script for everything. struct script_code *equip_script; ///< Script executed once when equipping. struct script_code *unequip_script; ///< Script executed once when unequipping. + struct script_code *rental_start_script; ///< Script executed once this item get rented + struct script_code *rental_end_script; ///< Script executed once this item rent ends struct { unsigned available : 1; unsigned no_refine : 1; // [celest] diff --git a/src/map/pc.c b/src/map/pc.c index 8ac820d79..b82eb5dae 100644 --- a/src/map/pc.c +++ b/src/map/pc.c @@ -4789,13 +4789,15 @@ static int pc_additem(struct map_session_data *sd, const struct item *item_data, pc->equipitem(sd, i, data->equip); /* rental item check */ - if( item_data->expire_time ) { - if( time(NULL) > item_data->expire_time ) { - pc->rental_expire(sd,i); + if (item_data->expire_time > 0) { + if (time(NULL) > item_data->expire_time) { + pc->rental_expire(sd, i); } else { - int seconds = (int)( item_data->expire_time - time(NULL) ); + int seconds = (int)(item_data->expire_time - time(NULL)); clif->rental_time(sd->fd, sd->status.inventory[i].nameid, seconds); pc->inventory_rental_add(sd, seconds); + if (data->rental_start_script != NULL) + script->run_item_rental_start_script(sd, data, 0); } } quest->questinfo_refresh(sd); @@ -4826,12 +4828,21 @@ static int pc_delitem(struct map_session_data *sd, int n, int amount, int type, sd->status.inventory[n].amount -= amount; sd->weight -= sd->inventory_data[n]->weight*amount ; + + // It's here because the data would most likely get zeroed in following if [Hemagx] + struct item_data *itd = sd->inventory_data[n]; + bool is_rental = (sd->status.inventory[n].expire_time > 0) ? true : false; + if( sd->status.inventory[n].amount <= 0 ){ if(sd->status.inventory[n].equip) pc->unequipitem(sd, n, PCUNEQUIPITEM_RECALC|PCUNEQUIPITEM_FORCE); memset(&sd->status.inventory[n],0,sizeof(sd->status.inventory[0])); sd->inventory_data[n] = NULL; } + + if (is_rental && itd->rental_end_script != NULL) + script->run_item_rental_end_script(sd, itd, 0); + if(!(type&1)) clif->delitem(sd,n,amount,reason); if(!(type&2)) diff --git a/src/map/script.c b/src/map/script.c index de00f66be..8658b7ab5 100644 --- a/src/map/script.c +++ b/src/map/script.c @@ -25891,6 +25891,36 @@ static void script_run_item_unequip_script(struct map_session_data *sd, struct i script->current_item_id = 0; } +static void script_run_item_rental_start_script(struct map_session_data *sd, struct item_data *data, int oid) __attribute__((nonnull(1, 2))); + +/** + * Run item rental start script + * @param sd player session data. Must be correct and checked before. + * @param data rental item data. Must be correct and checked before. + * @param oid npc id. Can be also 0 or fake npc id. + **/ +static void script_run_item_rental_start_script(struct map_session_data *sd, struct item_data *data, int oid) +{ + script->current_item_id = data->nameid; + script->run(data->rental_start_script, 0, sd->bl.id, oid); + script->current_item_id = 0; +} + +static void script_run_item_rental_end_script(struct map_session_data *sd, struct item_data *data, int oid) __attribute__((nonnull(1, 2))); + +/** +* Run item rental end script +* @param sd player session data. Must be correct and checked before. +* @param data rental item data. Must be correct and checked before. +* @param oid npc id. Can be also 0 or fake npc id. +**/ +static void script_run_item_rental_end_script(struct map_session_data *sd, struct item_data *data, int oid) +{ + script->current_item_id = data->nameid; + script->run(data->rental_end_script, 0, sd->bl.id, oid); + script->current_item_id = 0; +} + #define BUILDIN_DEF(x,args) { buildin_ ## x , #x , args, false } #define BUILDIN_DEF2(x,x2,args) { buildin_ ## x , x2 , args, false } #define BUILDIN_DEF_DEPRECATED(x,args) { buildin_ ## x , #x , args, true } @@ -27443,4 +27473,6 @@ void script_defaults(void) script->run_use_script = script_run_use_script; script->run_item_equip_script = script_run_item_equip_script; script->run_item_unequip_script = script_run_item_unequip_script; + script->run_item_rental_start_script = script_run_item_rental_start_script; + script->run_item_rental_end_script = script_run_item_rental_end_script; } diff --git a/src/map/script.h b/src/map/script.h index 64e709a27..a75b948ab 100644 --- a/src/map/script.h +++ b/src/map/script.h @@ -1049,6 +1049,8 @@ struct script_interface { void (*run_use_script) (struct map_session_data *sd, struct item_data *data, int oid); void (*run_item_equip_script) (struct map_session_data *sd, struct item_data *data, int oid); void (*run_item_unequip_script) (struct map_session_data *sd, struct item_data *data, int oid); + void (*run_item_rental_end_script) (struct map_session_data *sd, struct item_data *data, int oid); + void (*run_item_rental_start_script) (struct map_session_data *sd, struct item_data *data, int oid); }; #ifdef HERCULES_CORE |