fallout2sfall/sfall
0
0
Fork 0
mirror of https://github.com/sfall-team/sfall.git synced 2026-07-27 16:52:34 -07:00
Code Issues Packages Projects Releases Wiki Activity

Fixed set/remove_script script functions

Browse Source 
* they didn't set the script index number on non-critter objects.

Changed objects_in_radius to accept a radius of 0.

Edits to scripting documents.
This commit is contained in:
NovaRain
2026-04-23 22:24:37 +08:00
parent 91cc37dc17
commit fb47779d4c
5 changed files with 105 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacts/scripting/functions.yml
+36 -18
View File
@@ -794,12 +794,14 @@
doc: Should work like `art_change_fid_num` but in `reg_anim` sequence.
opcode: 0x825e
- name: reg_anim_take_out
detail: void reg_anim_take_out(ObjectPtr, holdFrameID, delay)
doc: Plays "take out weapon" animation for given `holdFrameID`. It is not required to have such weapon in critter's inventory.
detail: void reg_anim_take_out(ObjectPtr, int weaponCode, int delay)
doc: |
Plays "take out weapon" animation for the given `weaponCode` (see `WPN_ANIM_*` constants in **define_extra.h**).
- It is not required for the critter to have this type of weapon in its inventory.
opcode: 0x825f
- name: reg_anim_turn_towards
detail: void reg_anim_turn_towards(ObjectPtr, int tile/target, delay)
doc: Makes object change its direction to face given tile number or target object.
doc: Makes object change its direction to face the given tile number or target object.
opcode: 0x8260
- name: reg_anim_callback
detail: void reg_anim_callback(procedure proc)
@@ -816,7 +818,9 @@
items:
- name: art_exists
detail: int art_exists(int artFID)
doc: 'checks if given artFID exists in the game. Useful when you want to check if critter can use specific weapon: `art_exists((artFid bwand 0xffff0fff) bwor (weaponAnim * 0x1000))`.'
doc: |
Checks if the given `artFID` exists in the game.
- Useful when you want to check if critter can use specific weapon: `art_exists((artFid bwand 0xffff0fff) bwor (weaponAnim * 0x1000))`.
opcode: 0x8274
- name: refresh_pc_art
detail: void refresh_pc_art
@@ -852,14 +856,16 @@
opcode: 0x826d
- name: tile_get_objs
detail: array tile_get_objs(int tileNum, int elevation)
doc: Returns an array of all objects at given tile. It will include any hidden, dead or system objects (like cursor), so make sure to check properly when iterating.
doc: |
Returns an array of all objects at the given tile.
- It will include any hidden, dead or system objects (like cursor), so make sure to check properly when iterating.
opcode: 0x8270
- name: tile_refresh_display
detail: void tile_refresh_display
doc: Redraws the game scene (tiles, walls, objects, etc.).
- name: obj_blocking_tile
detail: ObjectPtr obj_blocking_tile(int tileNum, int elevation, int blockingType)
doc: Returns first object blocking given tile using given blocking function or 0 if tile is clear.
doc: Returns the first object blocking the given tile using the given blocking function, or 0 if the tile is clear.
opcode: 0x826f
- name: tile_by_position
@@ -870,20 +876,26 @@
macro: sfall.h
- name: get_tile_ground_fid
detail: int get_tile_ground_fid(int tileNum, int elevation)
doc: Returns FID of a ground tile at given tile number and elevation.
doc: Returns FID of a ground tile at the given tile number and elevation.
macro: sfall.h
- name: get_tile_roof_fid
detail: int get_tile_roof_fid(int tileNum, int elevation)
doc: Returns FID of a roof tile at given tile number and elevation. Note that FID of 1 is used when there is no actual roof.
doc: Returns FID of a roof tile at the given tile number and elevation. Note that FID of 1 is used when there is no actual roof.
macro: sfall.h
- name: obj_blocking_line
detail: ObjectPtr obj_blocking_line(ObjectPtr objFrom, int tileTo, int blockingType)
doc: Returns first object which blocks direct linear path from `objFrom` to `tileTo` using selected blocking function (see `BLOCKING_TYPE_*` constants in **sfall.h**). If path is clear (no blocker was encountered by selected function) - returns 0. `objFrom` is always excluded from calculations, but is required to be a valid object.
doc: |
Returns the first object which blocks direct linear path from `objFrom` to `tileTo` using selected blocking function (see `BLOCKING_TYPE_*` constants in **sfall.h**).
- If path is clear (no blocker was encountered by selected function) - returns 0.
- `objFrom` is always excluded from calculations, but is required to be a valid object.
opcode: 0x826e
- name: path_find_to
detail: array path_find_to(ObjectPtr objFrom, int tileTo, int blockingType)
doc: Returns the shortest path to a given tile using given blocking function as an array of tile directions (0..5) to move on each step. Array length equals to a number of steps. Empty array means that specified target cannot be reached.
doc: |
Returns the shortest path to a given tile using the given blocking function as an array of tile directions (0..5) to move on each step.
- Array length equals to a number of steps.
- Empty array means that specified target cannot be reached.
opcode: 0x8272
- name: Other
@@ -1062,7 +1074,7 @@
- name: create_spatial
detail: ObjectPtr create_spatial(int scriptID, int tile, int elevation, int radius)
doc: Creates new spatial script with given SID, at given tile, and radius.
doc: Creates new spatial script with the given scriptID at the given tile and radius.
opcode: 0x8273
- name: unwield_slot
@@ -1095,8 +1107,8 @@
- name: sprintf
detail: string sprintf(string format, any value)
doc: |
Formats given value using standart syntax of C `printf` function (google "printf" for format details). However, it is limited to formatting only 1 value.
- Can be used to get character by ASCII code ("%c").
Formats the given value using standard syntax of C `printf` function (google "printf" for format details). However, it is limited to formatting only 1 value.
- Can be used to get character by ASCII code (`%c`).
opcode: 0x8250
- name: typeof
detail: int typeof(any value)
@@ -1130,7 +1142,7 @@
opcode: 0x824f
- name: charcode
detail: int charcode(string text)
doc: Returns ASCII code for the first character in given string.
doc: Returns ASCII code for the first character in the given string.
opcode: 0x8251
- name: get_string_pointer
detail: int get_string_pointer(string text)
@@ -1427,7 +1439,7 @@
- name: spatial_radius
detail: int spatial_radius(ObjectPtr obj)
doc: Returns radius of spatial script, associated with given dummy-object (returned by `create_spatial`).
doc: Returns radius of spatial script, associated with the given dummy object (returned by `create_spatial`).
macro: sfall.h
- name: set_rest_heal_time
detail: void set_rest_heal_time(int time)
@@ -2010,12 +2022,16 @@
- name: set_script
detail: void set_script(ObjectPtr obj, int scriptID)
opcode: 0x81f4
doc: Accepts a pointer to an object and scriptID, and applies the given script to an object (scriptID accept the same values as `create_object_sid `from sfall 3.6). If used on an object that is already scripted, it will remove the existing script first; you cannot have multiple scripts attached to a single object. Calling `set_script` on `self_obj` will have all sorts of wacky side effects, and should be avoided. If you add 0x80000000 to the sid when calling `set_script`, `map_enter_p_proc` will be SKIPPED. The `start` proc will always be run.
doc: |
Accepts a pointer to an object and scriptID, and applies the given script to an object (scriptID accept the same values as `create_object_sid` from sfall 3.6).
- If used on an object that is already scripted, it will remove the existing script first; you cannot have multiple scripts attached to a single object.
- Calling `set_script` on `self_obj` will have all sorts of wacky side effects, and should be avoided.
- If you add 0x80000000 to the scriptID when calling `set_script`, `map_enter_p_proc` will be SKIPPED. The `start` proc will always be run.
- name: get_script
detail: int get_script(ObjectPtr obj)
opcode: 0x81f5
doc: |
- accepts a pointer to an object and returns its scriptID (line number in `scripts.lst`), or 0 if the object is unscripted.
Accepts a pointer to an object and returns its `scriptID` (line number in `scripts.lst`), or 0 if the object is unscripted.
- returns -1 on argument error.
- name: obj_is_carrying_obj
@@ -2058,7 +2074,9 @@
macro: sfall.h
- name: set_flags
detail: void set_flags(ObjectPtr obj, int flags)
doc: Sets the current flags of an object. All flags are rewritten with given integer, so first get current flags with `get_flags` and use `bwor/bwand` to set/remove specific flag.
doc: |
Sets the current flags of an object.
- All flags are rewritten with the given `flags` integer, so first get the current flags with `get_flags` and use `bwor`/`bwand` to set/remove specific flags.
macro: sfall.h
- name: set_unique_id