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

Changed PipBoyAvailableAtGameStart and set_pipboy_available

Browse Source 
* They no longer modify the vault suit movie state, which was an
undesired behavior.

Updated scripting documents.
This commit is contained in:
NovaRain
2025-03-02 11:26:03 +08:00
parent 8edd813ec1
commit 90872396ad
7 changed files with 39 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacts/scripting/functions.yml
+6 -4
View File
@@ -565,7 +565,7 @@
doc: |
Used to play `mp3/wav/wma` files. The path given is relative to the Fallout folder. Specify mode as 1 to loop the file continuously, 2 to replace the current background game music with playing the specified file in loop mode, or 0 to play the file once. If you don't wish to loop, `play_sfall_sound` returns 0. If you do loop, it returns an ID which can be passed back to `stop_sfall_sound` when you want to stop the effect. All sounds effects will be stopped on game reload, looping or not. Does not require `AllowDShowSound` to be set to 1 in `ddraw.ini`.
Starting from sfall 4.2.8/3.8.28, you can pass a value in the `mode` argument for a reduced sound volume. To set the volume, You need to convert the number to hexadecimal and use the argument format `0xZZZZ000Y`, where `ZZZZ` is the volume reduction value in range from 0 to 32767 (the value 32767 is mute), and `Y` is the playback mode.
Starting from sfall 4.2.8/3.8.28, you can pass a value in the `mode` argument for a reduced sound volume. To set the volume, you need to convert the number to hexadecimal and use the argument format `0xZZZZ000Y`, where `ZZZZ` is the volume reduction value in range from 0 to 32767 (the value 32767 is mute), and `Y` is the playback mode.
- name: stop_sfall_sound
detail: void stop_sfall_sound(int soundID)
opcode: 0x822c
@@ -891,7 +891,7 @@
- name: input_funcs_available
detail: int input_funcs_available()
opcode: 0x816b
doc: The input functions are only available if the user has the input hook turned on in `ddraw.ini`. Use `input_funcs_available` to check.
doc: (DEPRECATED) The input functions are only available if the user has the input hook turned on in `ddraw.ini`. Use `input_funcs_available` to check.
- name: get_year
detail: int get_year
opcode: 0x8163
@@ -981,7 +981,7 @@
- name: nb_create_char
detail: int nb_create_char()
opcode: 0x81f6
doc: "`nb_*` functions are reserved for the brotherhood tactical training mod, and should be avoided. Not implemented, always returns 0."
doc: (DEPRECATED) Reserved for the brotherhood tactical training mod, and should be avoided. Not implemented, always returns 0.
- name: get_proto_data
detail: int get_proto_data(int pid, int offset)
@@ -1573,7 +1573,9 @@
- name: set_global_script_type
detail: void set_global_script_type(int type)
opcode: 0x819b
doc: Only has an effect on the script it is called from. Every global script needs its own `game_loaded` block to correctly set up the script type.
doc: |
Only has an effect on the script it is called from. Every global script needs its own `game_loaded` block to correctly set up the script type.
- (DEPRECATED) Using type 1 requires the input wrapper to be enabled. Use `available_global_script_types` to check what is available.
- name: available_global_script_types
detail: int available_global_script_types
opcode: 0x819c