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

Updated docs for art_frame_data script function

Browse Source 
Minor code edits: type name, indentation/alignment, unified messages
This commit is contained in:
NovaRain
2024-05-07 21:05:42 +08:00
parent 8f10169661
commit e435e1d614
5 changed files with 31 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacts/scripting/functions.yml
+5 -5
View File
@@ -1690,13 +1690,13 @@
- name: art_frame_data
detail: array art_frame_data(string/int artFile/artId, int frame, int rotation)
doc: |
- returns dimensions of a given PCX or FRM frame as temp array in form: [width, height]
- artFile/artId: path to the PCX/FRM file (e.g. `art\\inven\\5mmap.frm`), or its FRM ID number (e.g. `0x7000026`, see specification of the FID format)
- returns the dimensions of a given PCX or FRM frame as a temp array in the form **[width, height]**
- `artFile/artId`: path to the PCX/FRM file (e.g. `art\\inven\\5mmap.frm`), or its FRM ID number (e.g. `0x7000026`, see specification of the FID format)
optional arguments:
- `frame`: frame number, the first frame starts from zero
- `rotation`: rotation to get the frame for, useful when reading FRM file by path
- `rotation`: rotation to get the frame for, useful when reading FRM files by path
macro: sfall.h
- name: interface_art_draw
detail: int sfall_func4("interface_art_draw", int winType, string artFile/int artID, int x, int y)
doc: |
@@ -1806,7 +1806,7 @@
doc: |
Fills the rectangle area of the currently selected script window with the specified color, or clears the window with transparent (index 0) color (call the function without arguments).
- `color`: the color index in the game palette (from 0 to 255)
- name: nterface_overlay
- name: interface_overlay
detail: sfall_func2("interface_overlay", int winType, int mode)
doc: |
Alternative form: `int sfall_func6("interface_overlay", int winType, 2, int x, int y, int width, int height)`.
artifacts/scripting/sfall function notes.md
+10
View File
@@ -1139,6 +1139,16 @@ sfall_funcX metarule functions
`void sfall_func0("signal_close_game")`
- Works in a similar way to vanilla function: `metarule(METARULE_SIGNAL_END_GAME, 0)`, but it will then close the game instead of only returning the player to the main menu
----
#### art_frame_data
`array sfall_func3("art_frame_data", string/int artFile/artId, int frame, int rotation)`
- Returns the dimensions of a given PCX or FRM frame as a temp array in the form **[width, height]**
- `artFile/artId`: path to the PCX/FRM file (e.g. `art\\inven\\5mmap.frm`), or its FRM ID number (e.g. `0x7000026`, see specification of the FID format)
**Optional arguments:**
- `frame`: frame number, the first frame starts from zero
- `rotation`: rotation to get the frame for, useful when reading FRM files by path
****
_See other documentation files (arrays.md, hookscripts.md) for related functions reference._