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

Added get_tile_fid and macros to function notes

Browse Source 
Some misc edits to documents.
This commit is contained in:
NovaRain
2023-06-13 12:32:49 +08:00
parent 492e31410c
commit 46a80fdb6a
9 changed files with 44 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacts/scripting/functions.yml
+9 -7
View File
@@ -791,7 +791,7 @@
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 num or target object.
doc: Makes object change its direction to face given tile number or target object.
opcode: 0x8260
- name: reg_anim_callback
detail: void reg_anim_callback(procedure proc)
@@ -825,9 +825,9 @@
- name: get_tile_fid
detail: int get_tile_fid(int tileData)
doc: |
- returns FID information about the square under the given tile at elevation 0
- pass elevation as 4-bit number in bits 25-28 to access other elevations
- pass result mode in bits 29-32: 0 - Ground FID, 1 - Roof FID, 2 - Raw data.
- Returns FID information about the square under the given tile at elevation 0
- Pass elevation as 4-bit number in bits 25-28 to access other elevations
- Pass result mode in bits 29-32: 0 - ground FID, 1 - roof FID, 2 - raw data.
opcode: 0x823a
- name: tile_under_cursor
detail: int tile_under_cursor
@@ -856,11 +856,11 @@
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 tileNum and elevation.
doc: Returns FID of a ground tile at 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 tileNum and elevation. Note that FID of 1 is used when there is no actual roof.
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.
macro: sfall.h
- name: obj_blocking_line
@@ -1110,7 +1110,9 @@
opcode: 0x8251
- name: get_string_pointer
detail: int get_string_pointer(string text)
doc: Returns a pointer to a string variable or to a text. DEPRECATED, just use normal strings instead.
doc: |
(DEPRECATED) Returns a pointer to a string variable or to a text
- __NOTE:__ this function is intended for use only in `HOOK_DESCRIPTIONOBJ`. Starting from sfall 4.3.9/3.8.39, you can return normal strings directly in the hook without calling the function
macro: sfall.h
- name: string_format
detail: string string_format(string format, any val1, any val2, ...)