Added reg_anim_animate_and_move script function (closes #497)

This commit is contained in:
NovaRain
2023-12-27 13:18:52 +08:00
parent cfcc66ad1a
commit 7e47607781
7 changed files with 137 additions and 106 deletions
+9 -1
View File
@@ -777,7 +777,9 @@
opcode: 0x825a
- name: reg_anim_animate_and_hide
detail: void reg_anim_animate_and_hide(ObjectPtr, int animID, int delay)
doc: Exactly like `reg_anim_animate` but the object will automatically disappear after the last animation frame (but not destroyed).
doc: |
Works exactly like `reg_anim_animate` but the object will automatically disappear after the last animation frame (but not destroyed).
- `delay`: delay from the previous animation. A value of -1 will execute the specified animation immediately after the previous one in the sequence ends.
opcode: 0x825b
- name: reg_anim_light
detail: void reg_anim_light(ObjectPtr, int light, int delay)
@@ -799,6 +801,12 @@
detail: void reg_anim_callback(procedure proc)
doc: Adds the given procedure to an animation sequence-list and executes it in the registered sequence.
opcode: 0x827e
- name: reg_anim_animate_and_move
detail: void reg_anim_animate_and_move(ObjectPtr, int tile, int animID, int delay)
doc: |
Plays the specified animation while simultaneously moving the object to the given tile.
- `delay`: delay from the previous animation. A value of -1 will execute the specified animation immediately after the previous one in the sequence ends.
macro: sfall.h
- name: Art and appearance
items:
+1
View File
@@ -364,6 +364,7 @@
#define overlay_clear_rectangle(winType, x, y, w, h) sfall_func6("interface_overlay", winType, 2, x, y, w, h)
#define overlay_destroy(winType) sfall_func2("interface_overlay", winType, 0)
#define real_dude_obj sfall_func0("real_dude_obj")
#define reg_anim_animate_and_move(obj, tile, animID, delay) sfall_func4("reg_anim_animate_and_move", obj, tile, animID, delay)
#define remove_all_timer_events sfall_func0("remove_timer_event")
#define remove_timer_event(fixedParam) sfall_func1("remove_timer_event", fixedParam)
#define set_can_rest_on_map(map, elev, value) sfall_func3("set_can_rest_on_map", map, elev, value)
+8 -1
View File
@@ -254,7 +254,8 @@ FUNCTION REFERENCE
-----
##### `void reg_anim_animate_and_hide(object obj, int animID, int delay)`
- Exactly like `reg_anim_animate` but the object will automatically disappear after the last animation frame (but not destroyed).
- Works exactly like `reg_anim_animate` but the object will automatically disappear after the last animation frame (but not destroyed).
- `delay`: delay from the previous animation. A value of -1 will execute the specified animation immediately after the previous one in the sequence ends.
-----
##### `void reg_anim_light(object obj, int light, int delay)`
@@ -1127,6 +1128,12 @@ sfall_funcX metarule functions
**Optional argument:**
- `pos`: the position at which to start the search. If negative, it indicates a position starting from the end of the string
----
#### reg_anim_animate_and_move
`void sfall_func4("reg_anim_animate_and_move", object obj, int tile, int animID, int delay)`
- Plays the specified animation while simultaneously moving the object to the given tile
- `delay`: delay from the previous animation. A value of -1 will execute the specified animation immediately after the previous one in the sequence ends
****
_See other documentation files (arrays.md, hookscripts.md) for related functions reference._