Skip to content

Commit 29b6d4b

Browse files
committed
Removed misleading parens from functions without args in documents
1 parent 36df793 commit 29b6d4b

File tree

3 files changed

+98
-98
lines changed

3 files changed

+98
-98
lines changed

artifacts/scripting/sfall function notes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Data types mentioned in this document:
107107
FUNCTION REFERENCE
108108
------------------
109109

110-
#### `int game_loaded()`
110+
#### `int game_loaded`
111111
- Returns 1 the first time it is called after a new game or game load, and 0 any time after. It works on an individual basis for each script, so one script wont interfere with others. Its primary use is for global scripts, so that they know when to call `set_global_script_repeat`, but it can be called from normal scripts too.
112112

113113
-----
@@ -145,16 +145,16 @@ FUNCTION REFERENCE
145145
- If the setting argument is in an invalid format, it returns -1 (integer).
146146

147147
-----
148-
#### `int get_game_mode()`
148+
#### `int get_game_mode`
149149
- Is a more flexible version of `in_world_map`. It will return a set of flags indicating which mode the game is currently in.
150150
- These flags are the same as those used in the `set_shader_mode` function.
151151

152152
-----
153-
#### `int get_uptime()`
153+
#### `int get_uptime`
154154
- Is just a wrapper around the windows `GetTickCount()` function. It's useful for making time fade effects in shaders, since they already have access to the current tick count.
155155

156156
-----
157-
#### `bool in_world_map()`
157+
#### `bool in_world_map`
158158
- Returns 1 if the player is looking at the world map, or 0 at any other time.
159159
- Obviously this is only useful in global scripts, since normal scripts will never get the chance to run on the world map.
160160

@@ -171,7 +171,7 @@ FUNCTION REFERENCE
171171
- In this case use `force_encounter_with_flags` with the `ENCOUNTER_FLAG_NO_CAR` flag set.
172172

173173
-----
174-
#### `int get_light_level()`
174+
#### `int get_light_level`
175175
- Ambient light level in range 0..65536
176176
- The value returned by `get_light_level` may not exactly match that set by `set_light_level`, as `set_light_level` applies modifiers from the night vision perk.
177177

@@ -433,7 +433,7 @@ FUNCTION REFERENCE
433433
- If a file has a specific number assigned in **ExtraGameMsgFileList**, its fileId will be (`0x2000` + assigned number). (e.g. with `ExtraGameMsgFileList=foo,bar:2,foobar` in **ddraw.ini**, bar.msg will be associated with 0x2002 and foobar.msg with 0x2003.)
434434

435435
-----
436-
#### `int sneak_success()`
436+
#### `int sneak_success`
437437
- Returns 1 if the player is currently sneaking, and last sneak attempt (roll against skill) was successful; 0 otherwise.
438438
- This calls an internal engine function which is used to determine the perception range of critters (which you can override using `HOOK_WITHINPERCEPTION`).
439439

artifacts/scripting/sfall opcode list.md

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
| 0x8242 | `void set_critter_skill_points(int critter, int skill, int value)` |
3434
| 0x8243 | `int get_critter_skill_points(int critter, int skill)` |
3535
| 0x8244 | `void set_available_skill_points(int value)` |
36-
| 0x8245 | `int get_available_skill_points()` |
36+
| 0x8245 | `int get_available_skill_points` |
3737
| 0x8246 | `void mod_skill_points_per_level(int value)` |
3838
|||
3939
| 0x81B4 | `void set_stat_max(int stat, int value)` |
@@ -43,45 +43,45 @@
4343
| 0x81B9 | `void set_npc_stat_max(int stat, int value)` |
4444
| 0x81BA | `void set_npc_stat_min(int stat, int value)` |
4545
|||
46-
| 0x816B | `int input_funcs_available()` |
46+
| 0x816B | `int input_funcs_available` |
4747
| 0x816C | `int key_pressed(int dxScancode)` |
4848
| 0x8162 | `void tap_key(int dxScancode)` |
49-
| 0x821C | `int get_mouse_x()` |
50-
| 0x821D | `int get_mouse_y()` |
51-
| 0x821E | `int get_mouse_buttons()` |
52-
| 0x821F | `int get_window_under_mouse()` |
49+
| 0x821C | `int get_mouse_x` |
50+
| 0x821D | `int get_mouse_y` |
51+
| 0x821E | `int get_mouse_buttons` |
52+
| 0x821F | `int get_window_under_mouse` |
5353
|||
54-
| 0x8163 | `int get_year()` |
54+
| 0x8163 | `int get_year` |
5555
|||
56-
| 0x8164 | `bool game_loaded()` |
56+
| 0x8164 | `bool game_loaded` |
5757
|||
58-
| 0x8165 | `bool graphics_funcs_available()` |
58+
| 0x8165 | `bool graphics_funcs_available` |
5959
| 0x8166 | `int load_shader(string path)` |
6060
| 0x8167 | `void free_shader(int ID)` |
6161
| 0x8168 | `void activate_shader(int ID)` |
6262
| 0x8169 | `void deactivate_shader(int ID)` |
6363
| 0x816D | `void set_shader_int(int ID, string param, int value)` |
6464
| 0x816E | `void set_shader_float(int ID, string param, float value)` |
6565
| 0x816F | `void set_shader_vector(int ID, string param, float f1, float f2, float f3, float f4)` |
66-
| 0x81AD | `int get_shader_version()` |
66+
| 0x81AD | `int get_shader_version` |
6767
| 0x81AE | `void set_shader_mode(int mode)` |
6868
| 0x81B0 | `void force_graphics_refresh(bool enabled)` |
6969
| 0x81B1 | `int get_shader_texture(int ID, int texture)` |
7070
| 0x81B2 | `void set_shader_texture(int ID, string param, int texID)` |
7171
|||
7272
| 0x816A | `void set_global_script_repeat(int frames)` |
7373
| 0x819B | `void set_global_script_type(int type)` |
74-
| 0x819C | `int available_global_script_types()` |
74+
| 0x819C | `int available_global_script_types` |
7575
|||
76-
| 0x8170 | `bool in_world_map()` |
76+
| 0x8170 | `bool in_world_map` |
7777
|||
7878
| 0x8171 | `void force_encounter(int map)` |
7979
| 0x8229 | `void force_encounter_with_flags(int map, int flags)` |
8080
| 0x822A | `void set_map_time_multi(float multi)` |
8181
|||
8282
| 0x8172 | `void set_world_map_pos(int x, int y)` |
83-
| 0x8173 | `int get_world_map_x_pos()` |
84-
| 0x8174 | `int get_world_map_y_pos()` |
83+
| 0x8173 | `int get_world_map_x_pos` |
84+
| 0x8174 | `int get_world_map_y_pos` |
8585
|||
8686
| 0x8175 | `void set_dm_model(string name)` |
8787
| 0x8176 | `void set_df_model(string name)` |
@@ -113,15 +113,15 @@
113113
| 0x818C | `int get_kill_counter(int critterType)` |
114114
| 0x818D | `void mod_kill_counter(int critterType, int amount)` |
115115
|||
116-
| 0x818E | `int get_perk_owed()` |
116+
| 0x818E | `int get_perk_owed` |
117117
| 0x818F | `void set_perk_owed(int value)` |
118118
| 0x8190 | `int get_perk_available(int perk)` |
119119
|||
120120
| 0x8191 | `int get_critter_current_ap(object critter)` |
121121
| 0x8192 | `void set_critter_current_ap(object critter, int ap)` |
122122
|||
123-
| 0x8193 | `int active_hand()` |
124-
| 0x8194 | `void toggle_active_hand()` |
123+
| 0x8193 | `int active_hand` |
124+
| 0x8194 | `void toggle_active_hand` |
125125
|||
126126
| 0x8195 | `void set_weapon_knockback(object weapon, int type, int/float value)` |
127127
| 0x8196 | `void set_target_knockback(object critter, int type, int/float value)` |
@@ -160,40 +160,40 @@
160160
| 0x81C9 | `void set_critter_pickpocket_mod(object, int max, int mod)` |
161161
| 0x81CA | `void set_base_pickpocket_mod(int max, int mod)` |
162162
|||
163-
| 0x81A3 | `int eax_available()` |
163+
| 0x81A3 | `int eax_available` |
164164
| 0x81A4 | `void set_eax_environment(int environment)` |
165165
|||
166166
| 0x81A5 | `void inc_npc_level(int pid/string name)` |
167167
| 0x8241 | `int get_npc_level(int pid/string name)` |
168168
|||
169-
| 0x81A6 | `int get_viewport_x()` |
170-
| 0x81A7 | `int get_viewport_y()` |
169+
| 0x81A6 | `int get_viewport_x` |
170+
| 0x81A7 | `int get_viewport_y` |
171171
| 0x81A8 | `void set_viewport_x(int view_x)` |
172172
| 0x81A9 | `void set_viewport_y(int view_y)` |
173173
|||
174174
| 0x81AC | `int get_ini_setting(string setting)` |
175175
| 0x81EB | `string get_ini_string(string setting)` |
176176
|||
177-
| 0x81AF | `int get_game_mode()` |
177+
| 0x81AF | `int get_game_mode` |
178178
|||
179-
| 0x81B3 | `int get_uptime()` |
179+
| 0x81B3 | `int get_uptime` |
180180
|||
181181
| 0x81B6 | `void set_car_current_town(int town)` |
182182
|||
183183
| 0x81BB | `void set_fake_perk(string name, int level, int image, string desc)` |
184184
| 0x81BC | `void set_fake_trait(string name, int active, int image, string desc)` |
185185
| 0x81BD | `void set_selectable_perk(string name, int active, int image, string desc)` |
186186
| 0x81BE | `void set_perkbox_title(string title)` |
187-
| 0x81BF | `void hide_real_perks()` |
188-
| 0x81C0 | `void show_real_perks()` |
187+
| 0x81BF | `void hide_real_perks` |
188+
| 0x81C0 | `void show_real_perks` |
189189
| 0x81C1 | `int has_fake_perk(string name/int extraPerkID)` |
190190
| 0x81C2 | `int has_fake_trait(string name)` |
191191
| 0x81C3 | `void perk_add_mode(int type)` |
192-
| 0x81C4 | `void clear_selectable_perks()` |
192+
| 0x81C4 | `void clear_selectable_perks` |
193193
| 0x8225 | `void remove_trait(int traitID)` |
194194
|||
195195
| 0x81CB | `void set_pyromaniac_mod(int bonus)` |
196-
| 0x81CC | `void apply_heaveho_fix()` |
196+
| 0x81CC | `void apply_heaveho_fix` |
197197
| 0x81CD | `void set_swiftlearner_mod(int bonus)` |
198198
| 0x81CE | `void set_hp_per_level_mod(int mod)` |
199199
|||
@@ -208,16 +208,16 @@
208208
| 0x81E2 | `int get_critical_table(int crittertype, int bodypart, int level, int valuetype)` |
209209
| 0x81E3 | `void reset_critical_table(int crittertype, int bodypart, int level, int valuetype)` |
210210
|||
211-
| 0x81E4 | `int get_sfall_arg()` |
212-
| 0x823C | `array get_sfall_args()` |
211+
| 0x81E4 | `int get_sfall_arg` |
212+
| 0x823C | `array get_sfall_args` |
213213
| 0x823D | `void set_sfall_arg(int argnum, int value)` |
214214
| 0x81E5 | `void set_sfall_return(any value)` |
215-
| 0x81EA | `int init_hook()` |
215+
| 0x81EA | `int init_hook` |
216216
|||
217217
| 0x81E6 | `void set_unspent_ap_bonus(int multiplier)` |
218-
| 0x81E7 | `int get_unspent_ap_bonus()` |
218+
| 0x81E7 | `int get_unspent_ap_bonus` |
219219
| 0x81E8 | `void set_unspent_ap_perk_bonus(int multiplier)` |
220-
| 0x81E9 | `int get_unspent_ap_perk_bonus()` |
220+
| 0x81E9 | `int get_unspent_ap_perk_bonus` |
221221
|||
222222
| 0x81EC | `float sqrt(float)` |
223223
| 0x81ED | `int/float abs(int/float)` |
@@ -237,7 +237,7 @@
237237
| 0x81F4 | `void set_script(object, int scriptid)` |
238238
| 0x81F5 | `int get_script(object)` |
239239
|||
240-
| 0x81F6 | `int nb_create_char()` |
240+
| 0x81F6 | `int nb_create_char` |
241241
|||
242242
| 0x81F7 | `int fs_create(string path, int size)` |
243243
| 0x81F8 | `int fs_copy(string path, string source)` |
@@ -269,9 +269,9 @@
269269
| 0x820F | `void list_end(int listid)` |
270270
| 0x8236 | `array list_as_array(int type)` |
271271
|||
272-
| 0x8210 | `int sfall_ver_major()` |
273-
| 0x8211 | `int sfall_ver_minor()` |
274-
| 0x8212 | `int sfall_ver_build()` |
272+
| 0x8210 | `int sfall_ver_major` |
273+
| 0x8211 | `int sfall_ver_minor` |
274+
| 0x8212 | `int sfall_ver_build` |
275275
|||
276276
| 0x8213 | `void hero_select_win(int)` |
277277
| 0x8214 | `void set_hero_race(int style)` |
@@ -284,18 +284,18 @@
284284
| 0x8219 | `int get_weapon_ammo_count(object weapon)` |
285285
| 0x821A | `void set_weapon_ammo_count(object weapon, int count)` |
286286
|||
287-
| 0x8220 | `int get_screen_width()` |
288-
| 0x8221 | `int get_screen_height()` |
287+
| 0x8220 | `int get_screen_width` |
288+
| 0x8221 | `int get_screen_height` |
289289
|||
290-
| 0x8222 | `void stop_game()` |
291-
| 0x8223 | `void resume_game()` |
290+
| 0x8222 | `void stop_game` |
291+
| 0x8223 | `void resume_game` |
292292
| 0x8224 | `void create_message_window(string message)` |
293293
|||
294-
| 0x8226 | `int get_light_level()` |
294+
| 0x8226 | `int get_light_level` |
295295
|||
296-
| 0x8227 | `void refresh_pc_art()` |
296+
| 0x8227 | `void refresh_pc_art` |
297297
|||
298-
| 0x8228 | `int get_attack_type()` |
298+
| 0x8228 | `int get_attack_type` |
299299
|||
300300
| 0x822B | `int play_sfall_sound(string file, int mode)` |
301301
| 0x822C | `void stop_sfall_sound(int soundID)` |
@@ -311,7 +311,7 @@
311311
|||
312312
| 0x823A | `int get_tile_fid(int tileData)` |
313313
|||
314-
| 0x823B | `int modified_ini()` |
314+
| 0x823B | `int modified_ini` |
315315
|||
316316
| 0x823E | `void force_aimed_shots(int pid)` |
317317
| 0x823F | `void disable_aimed_shots(int pid)` |
@@ -322,8 +322,8 @@
322322
| 0x8249 | `object get_last_attacker(object critter)` |
323323
| 0x824A | `void block_combat(int enable)` |
324324
|||
325-
| 0x824B | `int tile_under_cursor()` |
326-
| 0x824C | `int gdialog_get_barter_mod()` |
325+
| 0x824B | `int tile_under_cursor` |
326+
| 0x824C | `int gdialog_get_barter_mod` |
327327
| 0x824D | `void set_inven_ap_cost(int cost)` |
328328
|||
329329
| 0x825C | `void reg_anim_combat_check(int enable)` |
@@ -339,7 +339,7 @@
339339
| 0x8262 | `void register_hook_proc(int hook, procedure proc)` |
340340
|||
341341
| 0x826B | `string message_str_game(int fileId, int messageId)` |
342-
| 0x826C | `int sneak_success()` |
342+
| 0x826C | `int sneak_success` |
343343
| 0x826D | `int tile_light(int elevation, int tileNum)` |
344344
| 0x826E | `object obj_blocking_line(object objFrom, int tileTo, int blockingType)` |
345345
| 0x826F | `object obj_blocking_tile(int tileNum, int elevation, int blockingType)` |

0 commit comments

Comments
 (0)