@bgforge/mls-server 3.2.0 → 3.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/out/completion.fallout-ssl.json +50 -50
- package/out/completion.weidu-baf.json +2794 -218
- package/out/completion.weidu-d.json +16 -8
- package/out/completion.weidu-tp2.json +12 -6
- package/out/engine-proc-docs.json +1 -1
- package/out/hover.fallout-ssl.json +50 -50
- package/out/hover.weidu-baf.json +1753 -211
- package/out/hover.weidu-d.json +4 -4
- package/out/hover.weidu-tp2.json +1 -1
- package/out/server.js +370 -366
- package/out/tree-sitter-weidu_tp2.wasm +0 -0
- package/out/tssl-plugin.js +1 -1
- package/package.json +1 -1
|
@@ -329,7 +329,8 @@
|
|
|
329
329
|
"documentation": {
|
|
330
330
|
"kind": "markdown",
|
|
331
331
|
"value": "```weidu-d-tooltip\nEXTERN filename stateNumber\n```\nTransfer to the given state in the given dialogue file."
|
|
332
|
-
}
|
|
332
|
+
},
|
|
333
|
+
"detail": "EXTERN filename stateNumber"
|
|
333
334
|
},
|
|
334
335
|
{
|
|
335
336
|
"label": "COPY_TRANS",
|
|
@@ -339,7 +340,8 @@
|
|
|
339
340
|
"documentation": {
|
|
340
341
|
"kind": "markdown",
|
|
341
342
|
"value": "```weidu-d-tooltip\nCOPY_TRANS [ SAFE ] filename stateNumber\n```\nAt the end of the CHAIN text, copy all transitions from the given state in the given file. This is useful for interjections (see INTERJECT). If SAFE is specified, CHAIN will not warn about potentially unsafe uses of COPY_TRANS (use this if you know it is safe)."
|
|
342
|
-
}
|
|
343
|
+
},
|
|
344
|
+
"detail": "COPY_TRANS [ SAFE ] filename stateNumber"
|
|
343
345
|
},
|
|
344
346
|
{
|
|
345
347
|
"label": "COPY_TRANS_LATE",
|
|
@@ -349,7 +351,8 @@
|
|
|
349
351
|
"documentation": {
|
|
350
352
|
"kind": "markdown",
|
|
351
353
|
"value": "```weidu-d-tooltip\nCOPY_TRANS_LATE [ SAFE ] filename stateNumber\n```\nSame as above, but only copy after all the other D Actions have been applied."
|
|
352
|
-
}
|
|
354
|
+
},
|
|
355
|
+
"detail": "COPY_TRANS_LATE [ SAFE ] filename stateNumber"
|
|
353
356
|
},
|
|
354
357
|
{
|
|
355
358
|
"label": "EXIT",
|
|
@@ -359,7 +362,8 @@
|
|
|
359
362
|
"documentation": {
|
|
360
363
|
"kind": "markdown",
|
|
361
364
|
"value": "```weidu-d-tooltip\nEXIT\n```\nAt the end of the CHAIN text, exit the dialogue."
|
|
362
|
-
}
|
|
365
|
+
},
|
|
366
|
+
"detail": "EXIT"
|
|
363
367
|
},
|
|
364
368
|
{
|
|
365
369
|
"label": "APPENDI",
|
|
@@ -409,7 +413,8 @@
|
|
|
409
413
|
"documentation": {
|
|
410
414
|
"kind": "markdown",
|
|
411
415
|
"value": "```weidu-d-tooltip\nCOPY_TRANS [ SAFE ] filename stateLabel\n```\nThis instructs WeiDU to copy all of the transitions from the state with the given stateLabel in filename.DLG. This copying takes place before all other D Actions. For example, this is a valid transition list: IF ~Before()~ THEN GOTO my_state COPY_TRANS PLAYER1 33 IF ~After()~ THEN EXTERN SOLA 55 If SAFE is specified, COPY_TRANS will not warn about potentially unsafe uses (use this if you know it is safe)."
|
|
412
|
-
}
|
|
416
|
+
},
|
|
417
|
+
"detail": "COPY_TRANS [ SAFE ] filename stateLabel"
|
|
413
418
|
},
|
|
414
419
|
{
|
|
415
420
|
"label": "COPY_TRANS_LATE",
|
|
@@ -419,7 +424,8 @@
|
|
|
419
424
|
"documentation": {
|
|
420
425
|
"kind": "markdown",
|
|
421
426
|
"value": "```weidu-d-tooltip\nCOPY_TRANS_LATE [ SAFE ] filename stateLabel\n```\nSame as COPY_TRANS, but is invoked after all other D Actions."
|
|
422
|
-
}
|
|
427
|
+
},
|
|
428
|
+
"detail": "COPY_TRANS_LATE [ SAFE ] filename stateLabel"
|
|
423
429
|
},
|
|
424
430
|
{
|
|
425
431
|
"label": "REPLY",
|
|
@@ -499,7 +505,8 @@
|
|
|
499
505
|
"documentation": {
|
|
500
506
|
"kind": "markdown",
|
|
501
507
|
"value": "```weidu-d-tooltip\nEXTERN [ IF_FILE_EXISTS ] filename stateLabel\n```\nThe dialogue continues at the state with label stateLabel in the file filename.DLG. The whole transition is not compiled if there's IF_FILE_EXISTS and the file filename doesn't exist."
|
|
502
|
-
}
|
|
508
|
+
},
|
|
509
|
+
"detail": "EXTERN [ IF_FILE_EXISTS ] filename stateLabel"
|
|
503
510
|
},
|
|
504
511
|
{
|
|
505
512
|
"label": "EXIT",
|
|
@@ -509,7 +516,8 @@
|
|
|
509
516
|
"documentation": {
|
|
510
517
|
"kind": "markdown",
|
|
511
518
|
"value": "```weidu-d-tooltip\nEXIT\n```\nThe conversation ends."
|
|
512
|
-
}
|
|
519
|
+
},
|
|
520
|
+
"detail": "EXIT"
|
|
513
521
|
},
|
|
514
522
|
{
|
|
515
523
|
"label": "IF",
|
|
@@ -697,7 +697,8 @@
|
|
|
697
697
|
"documentation": {
|
|
698
698
|
"kind": "markdown",
|
|
699
699
|
"value": "```weidu-tp2-tooltip\nBEGIN componentName [ component flags... ] TP2 Action list\n```\nStarts a new component. Each component has a name, optional component flags (DESIGNATED, GROUP, etc.), and a list of actions to perform."
|
|
700
|
-
}
|
|
700
|
+
},
|
|
701
|
+
"detail": "BEGIN componentName [ component flags... ] TP2 Action list"
|
|
701
702
|
},
|
|
702
703
|
{
|
|
703
704
|
"label": "LANGUAGE",
|
|
@@ -2479,7 +2480,8 @@
|
|
|
2479
2480
|
"documentation": {
|
|
2480
2481
|
"kind": "markdown",
|
|
2481
2482
|
"value": "```weidu-tp2-tooltip\nEVALUATE_BUFFER\n```\nAny WeiDU variables (like %myvar%) inside the current file (which should probably be a plain text file in order for this to make much sense) are replaced by their values. Example: <<<<<<<< .../mymod-inlined/script.baf IF See(%myvar%) THEN RESPONSE #100 Kill(%myvar%) END >>>>>>>> EXTEND_TOP ~sola.bcs~ ~.../mymod-inlined/script.baf~ SPRINT myvar = ~\"Anomen\"~ EVALUATE_BUFFER Those two actions extend the top of sola.bcs with the script block IF See(\"Anomen\") THEN RESPONSE #100 Kill(\"Anomen\") END. You can also use EVALUATE_BUFFER in COMPILE actions or before strings in values. You may use EVAL as a synonym for EVALUATE_BUFFER."
|
|
2482
|
-
}
|
|
2483
|
+
},
|
|
2484
|
+
"detail": "EVALUATE_BUFFER"
|
|
2483
2485
|
},
|
|
2484
2486
|
{
|
|
2485
2487
|
"label": "EVALUATE_BUFFER_SPECIAL",
|
|
@@ -3835,7 +3837,8 @@
|
|
|
3835
3837
|
"label": "BEGIN",
|
|
3836
3838
|
"kind": 14,
|
|
3837
3839
|
"source": "builtin",
|
|
3838
|
-
"category": "value"
|
|
3840
|
+
"category": "value",
|
|
3841
|
+
"detail": "BEGIN"
|
|
3839
3842
|
},
|
|
3840
3843
|
{
|
|
3841
3844
|
"label": "ELSE",
|
|
@@ -4487,7 +4490,8 @@
|
|
|
4487
4490
|
"documentation": {
|
|
4488
4491
|
"kind": "markdown",
|
|
4489
4492
|
"value": "```weidu-tp2-tooltip\nEVALUATE_BUFFER variable\n```\nUser variables inside the given string are evaluated one additional time. You may prepend `EVALUATE_BUFFER` when a value is called for and you would normally use a string. You may also use it for `SET` and `SPRINT` statements. Example:\n```\nSPRINT x ~y~\nSET y = 5\nSPRINT z EVALUATE_BUFFER ~tricky %%x%%~\nSET EVALUATE_BUFFER \"%x%\" += 77\nPATCH_PRINT \"y is %y% ; z is %z%\"\n```\nThis prints out `y is 82 ; z is tricky 5`. You may also do hackery like `FILE_SIZE \"myfile\" \"%%indirection%%\"`. Be very careful with this feature."
|
|
4490
|
-
}
|
|
4493
|
+
},
|
|
4494
|
+
"detail": "EVALUATE_BUFFER variable"
|
|
4491
4495
|
},
|
|
4492
4496
|
{
|
|
4493
4497
|
"label": "EVAL",
|
|
@@ -5593,7 +5597,8 @@
|
|
|
5593
5597
|
"documentation": {
|
|
5594
5598
|
"kind": "markdown",
|
|
5595
5599
|
"value": "```weidu-tp2-tooltip\nSTR_VAR\n```\nString variable"
|
|
5596
|
-
}
|
|
5600
|
+
},
|
|
5601
|
+
"detail": "STR_VAR"
|
|
5597
5602
|
},
|
|
5598
5603
|
{
|
|
5599
5604
|
"label": "TARGET_IMMUNE",
|
|
@@ -5783,7 +5788,8 @@
|
|
|
5783
5788
|
"documentation": {
|
|
5784
5789
|
"kind": "markdown",
|
|
5785
5790
|
"value": "```weidu-tp2-tooltip\nSTR_VAR\n```\nString variable"
|
|
5786
|
-
}
|
|
5791
|
+
},
|
|
5792
|
+
"detail": "STR_VAR"
|
|
5787
5793
|
},
|
|
5788
5794
|
{
|
|
5789
5795
|
"label": "RET",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"spatial_p_proc": "Called when an object passes over the self-object's spatial trigger area.",
|
|
21
21
|
"start": "Called by the engine when the script is first run or the game object is first created, then never again, unless specifically called from somewhere else.",
|
|
22
22
|
"talk_p_proc": "Called when the player tries to initiate dialogue with the critter.",
|
|
23
|
-
"timed_event_p_proc": "This procedure is called by the function `add_timer_event(
|
|
23
|
+
"timed_event_p_proc": "This procedure is called by the function `add_timer_event(ObjectPtr obj, int time, int fixed_param)`.\n`ObjectPtr` points to the object whose script's `timed_event_p_proc` procedure you want to access.\nTime is the number of game ticks (1 game tick = 1/10 seconds) you want to pass before the `timed_event_p_proc` is called.\n`fixed_param` is a variable you can set to differentiate between various timed events.\nIn `timed_event_p_proc`, you can check the value of `fixed_param` against whatever number you used when calling `add_timer_event`.\nThis allows for multiple uses of `timed_event_p_proc` in the same script.",
|
|
24
24
|
"use_ad_on_p_proc": "Called when an advantage is used on the object.",
|
|
25
25
|
"use_disad_on_p_proc": "Called when a disadvantage is used on the object.",
|
|
26
26
|
"use_obj_on_p_proc": "Called when:\n- A critter uses an object on another critter. (Or themselves).\n- A critter uses an object from inventory screen AND this object does not have \"Use\" action flag set and it's not active flare or explosive.\n- Player or AI uses any drug.\nThe parameter `obj_being_used_with` receives a pointer to the object that was used.",
|
|
@@ -128,7 +128,7 @@
|
|
|
128
128
|
"timed_event_p_proc": {
|
|
129
129
|
"contents": {
|
|
130
130
|
"kind": "markdown",
|
|
131
|
-
"value": "```fallout-ssl-tooltip\nvoid timed_event_p_proc()\n```\nThis procedure is called by the function `add_timer_event(
|
|
131
|
+
"value": "```fallout-ssl-tooltip\nvoid timed_event_p_proc()\n```\nThis procedure is called by the function `add_timer_event(ObjectPtr obj, int time, int fixed_param)`.\n`ObjectPtr` points to the object whose script's `timed_event_p_proc` procedure you want to access.\nTime is the number of game ticks (1 game tick = 1/10 seconds) you want to pass before the `timed_event_p_proc` is called.\n`fixed_param` is a variable you can set to differentiate between various timed events.\nIn `timed_event_p_proc`, you can check the value of `fixed_param` against whatever number you used when calling `add_timer_event`.\nThis allows for multiple uses of `timed_event_p_proc` in the same script."
|
|
132
132
|
}
|
|
133
133
|
},
|
|
134
134
|
"use_ad_on_p_proc": {
|
|
@@ -2120,7 +2120,7 @@
|
|
|
2120
2120
|
"art_cache_clear": {
|
|
2121
2121
|
"contents": {
|
|
2122
2122
|
"kind": "markdown",
|
|
2123
|
-
"value": "```fallout-ssl-tooltip\nvoid art_cache_clear
|
|
2123
|
+
"value": "```fallout-ssl-tooltip\nvoid art_cache_clear\n```\nClears the cache of FRM image files loaded into memory."
|
|
2124
2124
|
}
|
|
2125
2125
|
},
|
|
2126
2126
|
"art_exists": {
|
|
@@ -2150,7 +2150,7 @@
|
|
|
2150
2150
|
"eax_available": {
|
|
2151
2151
|
"contents": {
|
|
2152
2152
|
"kind": "markdown",
|
|
2153
|
-
"value": "```fallout-ssl-tooltip\nint eax_available
|
|
2153
|
+
"value": "```fallout-ssl-tooltip\nint eax_available\n```\nObsolete since sfall 2.1a. Always returns 0."
|
|
2154
2154
|
}
|
|
2155
2155
|
},
|
|
2156
2156
|
"play_sfall_sound": {
|
|
@@ -2174,7 +2174,7 @@
|
|
|
2174
2174
|
"car_gas_amount": {
|
|
2175
2175
|
"contents": {
|
|
2176
2176
|
"kind": "markdown",
|
|
2177
|
-
"value": "```fallout-ssl-tooltip\nint car_gas_amount
|
|
2177
|
+
"value": "```fallout-ssl-tooltip\nint car_gas_amount\n```\nReturns the current amount of fuel in player's car (between 0 and 80000).\nTo change fuel amount, use vanilla function: `metarule(METARULE_GIVE_CAR_GAS, amount)` - `amount` can be positive or negative.\n"
|
|
2178
2178
|
}
|
|
2179
2179
|
},
|
|
2180
2180
|
"set_car_current_town": {
|
|
@@ -2192,7 +2192,7 @@
|
|
|
2192
2192
|
"attack_is_aimed": {
|
|
2193
2193
|
"contents": {
|
|
2194
2194
|
"kind": "markdown",
|
|
2195
|
-
"value": "```fallout-ssl-tooltip\nbool attack_is_aimed
|
|
2195
|
+
"value": "```fallout-ssl-tooltip\nbool attack_is_aimed\n```\nReturns 1 if the aimed attack mode is selected, 0 otherwise."
|
|
2196
2196
|
}
|
|
2197
2197
|
},
|
|
2198
2198
|
"block_combat": {
|
|
@@ -2234,7 +2234,7 @@
|
|
|
2234
2234
|
"get_combat_free_move": {
|
|
2235
2235
|
"contents": {
|
|
2236
2236
|
"kind": "markdown",
|
|
2237
|
-
"value": "```fallout-ssl-tooltip\nint get_combat_free_move
|
|
2237
|
+
"value": "```fallout-ssl-tooltip\nint get_combat_free_move\n```\nReturns available \"bonus move\" points of the current critter's turn. For NPCs, this is always 0 unless changed by `set_combat_free_move`"
|
|
2238
2238
|
}
|
|
2239
2239
|
},
|
|
2240
2240
|
"get_critical_table": {
|
|
@@ -2306,7 +2306,7 @@
|
|
|
2306
2306
|
"get_cursor_mode": {
|
|
2307
2307
|
"contents": {
|
|
2308
2308
|
"kind": "markdown",
|
|
2309
|
-
"value": "```fallout-ssl-tooltip\nint get_cursor_mode
|
|
2309
|
+
"value": "```fallout-ssl-tooltip\nint get_cursor_mode\n```\nReturns the current cursor mode. Values: 0 - movement cursor, 1 - command cursor, 2 - targeting cursor, 4 to 10 are Skilldex skills (yellow targeting cursor)."
|
|
2310
2310
|
}
|
|
2311
2311
|
},
|
|
2312
2312
|
"set_cursor_mode": {
|
|
@@ -2444,13 +2444,13 @@
|
|
|
2444
2444
|
"get_screen_height": {
|
|
2445
2445
|
"contents": {
|
|
2446
2446
|
"kind": "markdown",
|
|
2447
|
-
"value": "```fallout-ssl-tooltip\nint get_screen_height
|
|
2447
|
+
"value": "```fallout-ssl-tooltip\nint get_screen_height\n```\nThe graphics functions are only available if the user is using graphics mode 4 or 5. Use `graphics_funcs_available` to check; it returns 1 if you can use them or 0 if you can't. Calling graphics functions when `graphics_funcs_available` returns 0 will do nothing."
|
|
2448
2448
|
}
|
|
2449
2449
|
},
|
|
2450
2450
|
"get_screen_width": {
|
|
2451
2451
|
"contents": {
|
|
2452
2452
|
"kind": "markdown",
|
|
2453
|
-
"value": "```fallout-ssl-tooltip\nint get_screen_width
|
|
2453
|
+
"value": "```fallout-ssl-tooltip\nint get_screen_width\n```\nThe graphics functions are only available if the user is using graphics mode 4 or 5. Use `graphics_funcs_available` to check; it returns 1 if you can use them or 0 if you can't. Calling graphics functions when `graphics_funcs_available` returns 0 will do nothing."
|
|
2454
2454
|
}
|
|
2455
2455
|
},
|
|
2456
2456
|
"get_shader_texture": {
|
|
@@ -2516,7 +2516,7 @@
|
|
|
2516
2516
|
"get_sfall_arg": {
|
|
2517
2517
|
"contents": {
|
|
2518
2518
|
"kind": "markdown",
|
|
2519
|
-
"value": "```fallout-ssl-tooltip\nmixed get_sfall_arg
|
|
2519
|
+
"value": "```fallout-ssl-tooltip\nmixed get_sfall_arg\n```\nGets the next argument from sfall. Each time it's called it returns the next argument, or otherwise it returns 0 if there are no more arguments left. You can arbitrarily get the value of any argument using the `sfall_func1(\"get_sfall_arg_at\", argNum)` function."
|
|
2520
2520
|
}
|
|
2521
2521
|
},
|
|
2522
2522
|
"get_sfall_arg_at": {
|
|
@@ -2528,13 +2528,13 @@
|
|
|
2528
2528
|
"get_sfall_args": {
|
|
2529
2529
|
"contents": {
|
|
2530
2530
|
"kind": "markdown",
|
|
2531
|
-
"value": "```fallout-ssl-tooltip\nint get_sfall_args
|
|
2531
|
+
"value": "```fallout-ssl-tooltip\nint get_sfall_args\n```\nReturns all hook arguments as a new temp array."
|
|
2532
2532
|
}
|
|
2533
2533
|
},
|
|
2534
2534
|
"init_hook": {
|
|
2535
2535
|
"contents": {
|
|
2536
2536
|
"kind": "markdown",
|
|
2537
|
-
"value": "```fallout-ssl-tooltip\nint init_hook
|
|
2537
|
+
"value": "```fallout-ssl-tooltip\nint init_hook\n```\nThe hook script equivalent of `game_loaded`; it returns 1 when the script is loaded for the first time or when the player reloads the game, and 0 otherwise."
|
|
2538
2538
|
}
|
|
2539
2539
|
},
|
|
2540
2540
|
"register_hook": {
|
|
@@ -2618,7 +2618,7 @@
|
|
|
2618
2618
|
"display_stats": {
|
|
2619
2619
|
"contents": {
|
|
2620
2620
|
"kind": "markdown",
|
|
2621
|
-
"value": "```fallout-ssl-tooltip\nvoid display_stats
|
|
2621
|
+
"value": "```fallout-ssl-tooltip\nvoid display_stats\n```\n- Updates player's stats in the inventory display window or on the character screen.\n- NOTE: works only when the interface window is opened\n"
|
|
2622
2622
|
}
|
|
2623
2623
|
},
|
|
2624
2624
|
"inventory_redraw": {
|
|
@@ -2630,19 +2630,19 @@
|
|
|
2630
2630
|
"get_mouse_buttons": {
|
|
2631
2631
|
"contents": {
|
|
2632
2632
|
"kind": "markdown",
|
|
2633
|
-
"value": "```fallout-ssl-tooltip\nint get_mouse_buttons
|
|
2633
|
+
"value": "```fallout-ssl-tooltip\nint get_mouse_buttons\n```\nReturns the number of the mouse button that is currently pressed (1 - left, 2 - right, 3 - left+right, 4 - middle, 0 otherwise)."
|
|
2634
2634
|
}
|
|
2635
2635
|
},
|
|
2636
2636
|
"get_mouse_x": {
|
|
2637
2637
|
"contents": {
|
|
2638
2638
|
"kind": "markdown",
|
|
2639
|
-
"value": "```fallout-ssl-tooltip\nint get_mouse_x
|
|
2639
|
+
"value": "```fallout-ssl-tooltip\nint get_mouse_x\n```"
|
|
2640
2640
|
}
|
|
2641
2641
|
},
|
|
2642
2642
|
"get_mouse_y": {
|
|
2643
2643
|
"contents": {
|
|
2644
2644
|
"kind": "markdown",
|
|
2645
|
-
"value": "```fallout-ssl-tooltip\nint get_mouse_y
|
|
2645
|
+
"value": "```fallout-ssl-tooltip\nint get_mouse_y\n```"
|
|
2646
2646
|
}
|
|
2647
2647
|
},
|
|
2648
2648
|
"key_pressed": {
|
|
@@ -2744,13 +2744,13 @@
|
|
|
2744
2744
|
"intface_hide": {
|
|
2745
2745
|
"contents": {
|
|
2746
2746
|
"kind": "markdown",
|
|
2747
|
-
"value": "```fallout-ssl-tooltip\nvoid intface_hide
|
|
2747
|
+
"value": "```fallout-ssl-tooltip\nvoid intface_hide\n```\nHides main interface."
|
|
2748
2748
|
}
|
|
2749
2749
|
},
|
|
2750
2750
|
"intface_is_hidden": {
|
|
2751
2751
|
"contents": {
|
|
2752
2752
|
"kind": "markdown",
|
|
2753
|
-
"value": "```fallout-ssl-tooltip\nbool intface_is_hidden
|
|
2753
|
+
"value": "```fallout-ssl-tooltip\nbool intface_is_hidden\n```\nReturns 1 if interface is currently hidden, 0 otherwise."
|
|
2754
2754
|
}
|
|
2755
2755
|
},
|
|
2756
2756
|
"intface_redraw": {
|
|
@@ -2762,13 +2762,13 @@
|
|
|
2762
2762
|
"intface_show": {
|
|
2763
2763
|
"contents": {
|
|
2764
2764
|
"kind": "markdown",
|
|
2765
|
-
"value": "```fallout-ssl-tooltip\nvoid intface_show
|
|
2765
|
+
"value": "```fallout-ssl-tooltip\nvoid intface_show\n```\nShows main interface."
|
|
2766
2766
|
}
|
|
2767
2767
|
},
|
|
2768
2768
|
"exec_map_update_scripts": {
|
|
2769
2769
|
"contents": {
|
|
2770
2770
|
"kind": "markdown",
|
|
2771
|
-
"value": "```fallout-ssl-tooltip\nvoid exec_map_update_scripts
|
|
2771
|
+
"value": "```fallout-ssl-tooltip\nvoid exec_map_update_scripts\n```\nExecutes `map_update_p_proc` for all objects on map and global/hook scripts as well."
|
|
2772
2772
|
}
|
|
2773
2773
|
},
|
|
2774
2774
|
"force_encounter": {
|
|
@@ -2786,7 +2786,7 @@
|
|
|
2786
2786
|
"get_map_enter_position": {
|
|
2787
2787
|
"contents": {
|
|
2788
2788
|
"kind": "markdown",
|
|
2789
|
-
"value": "```fallout-ssl-tooltip\narray get_map_enter_position
|
|
2789
|
+
"value": "```fallout-ssl-tooltip\narray get_map_enter_position\n```\nReturns an array of the player's position data (index: 0 - tile, 1 - elevation, 2 - rotation) when entering the map through exit grids. If entering from the world map, the tile value will be -1. Should be called in `map_enter_p_proc` procedure to get the correct position data."
|
|
2790
2790
|
}
|
|
2791
2791
|
},
|
|
2792
2792
|
"get_terrain_name": {
|
|
@@ -2936,7 +2936,7 @@
|
|
|
2936
2936
|
"dialog_obj": {
|
|
2937
2937
|
"contents": {
|
|
2938
2938
|
"kind": "markdown",
|
|
2939
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr dialog_obj
|
|
2939
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr dialog_obj\n```\nReturns a pointer to the object (critter) the player is having a conversation or bartering with."
|
|
2940
2940
|
}
|
|
2941
2941
|
},
|
|
2942
2942
|
"get_flags": {
|
|
@@ -2960,7 +2960,7 @@
|
|
|
2960
2960
|
"loot_obj": {
|
|
2961
2961
|
"contents": {
|
|
2962
2962
|
"kind": "markdown",
|
|
2963
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr loot_obj
|
|
2963
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr loot_obj\n```\nReturns a pointer to the target object (container or critter) of the loot screen."
|
|
2964
2964
|
}
|
|
2965
2965
|
},
|
|
2966
2966
|
"obj_is_carrying_obj": {
|
|
@@ -2984,7 +2984,7 @@
|
|
|
2984
2984
|
"real_dude_obj": {
|
|
2985
2985
|
"contents": {
|
|
2986
2986
|
"kind": "markdown",
|
|
2987
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr real_dude_obj
|
|
2987
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr real_dude_obj\n```\nReturns the initial `dude_obj` after `set_dude_obj` was used."
|
|
2988
2988
|
}
|
|
2989
2989
|
},
|
|
2990
2990
|
"remove_script": {
|
|
@@ -3062,7 +3062,7 @@
|
|
|
3062
3062
|
"game_loaded": {
|
|
3063
3063
|
"contents": {
|
|
3064
3064
|
"kind": "markdown",
|
|
3065
|
-
"value": "```fallout-ssl-tooltip\nint game_loaded
|
|
3065
|
+
"value": "```fallout-ssl-tooltip\nint game_loaded\n```\nReturns 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."
|
|
3066
3066
|
}
|
|
3067
3067
|
},
|
|
3068
3068
|
"gdialog_get_barter_mod": {
|
|
@@ -3074,7 +3074,7 @@
|
|
|
3074
3074
|
"get_game_mode": {
|
|
3075
3075
|
"contents": {
|
|
3076
3076
|
"kind": "markdown",
|
|
3077
|
-
"value": "```fallout-ssl-tooltip\nint get_game_mode
|
|
3077
|
+
"value": "```fallout-ssl-tooltip\nint get_game_mode\n```\nA more flexible version of in_world_map. It will return a set of flags indicating which mode the game is currently in. These flags are the same as those used in the `set_shader_mode function`."
|
|
3078
3078
|
}
|
|
3079
3079
|
},
|
|
3080
3080
|
"get_inven_ap_cost": {
|
|
@@ -3092,7 +3092,7 @@
|
|
|
3092
3092
|
"get_light_level": {
|
|
3093
3093
|
"contents": {
|
|
3094
3094
|
"kind": "markdown",
|
|
3095
|
-
"value": "```fallout-ssl-tooltip\nint get_light_level
|
|
3095
|
+
"value": "```fallout-ssl-tooltip\nint get_light_level\n```\nReturns ambient light level in range 0..65536. 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."
|
|
3096
3096
|
}
|
|
3097
3097
|
},
|
|
3098
3098
|
"get_npc_level": {
|
|
@@ -3110,31 +3110,31 @@
|
|
|
3110
3110
|
"get_unspent_ap_bonus": {
|
|
3111
3111
|
"contents": {
|
|
3112
3112
|
"kind": "markdown",
|
|
3113
|
-
"value": "```fallout-ssl-tooltip\nint get_unspent_ap_bonus
|
|
3113
|
+
"value": "```fallout-ssl-tooltip\nint get_unspent_ap_bonus\n```\nGets the AC bonus you receive per unused action point at the end of your turn in combat. To allow for fractional values, the value given if divided by 4. (Hence the default value is 4 and not 1.)"
|
|
3114
3114
|
}
|
|
3115
3115
|
},
|
|
3116
3116
|
"get_unspent_ap_perk_bonus": {
|
|
3117
3117
|
"contents": {
|
|
3118
3118
|
"kind": "markdown",
|
|
3119
|
-
"value": "```fallout-ssl-tooltip\nint get_unspent_ap_perk_bonus
|
|
3119
|
+
"value": "```fallout-ssl-tooltip\nint get_unspent_ap_perk_bonus\n```\nSimilar to `get_unspent_ap_bonus`, but accounts for the extra AC granted by the H2H Evade perk. (The default value of this is also 4, equivalent to doubling the original bonus."
|
|
3120
3120
|
}
|
|
3121
3121
|
},
|
|
3122
3122
|
"get_uptime": {
|
|
3123
3123
|
"contents": {
|
|
3124
3124
|
"kind": "markdown",
|
|
3125
|
-
"value": "```fallout-ssl-tooltip\nint get_uptime
|
|
3125
|
+
"value": "```fallout-ssl-tooltip\nint get_uptime\n```\nJust 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."
|
|
3126
3126
|
}
|
|
3127
3127
|
},
|
|
3128
3128
|
"get_viewport_x": {
|
|
3129
3129
|
"contents": {
|
|
3130
3130
|
"kind": "markdown",
|
|
3131
|
-
"value": "```fallout-ssl-tooltip\nint get_viewport_x
|
|
3131
|
+
"value": "```fallout-ssl-tooltip\nint get_viewport_x\n```"
|
|
3132
3132
|
}
|
|
3133
3133
|
},
|
|
3134
3134
|
"get_viewport_y": {
|
|
3135
3135
|
"contents": {
|
|
3136
3136
|
"kind": "markdown",
|
|
3137
|
-
"value": "```fallout-ssl-tooltip\nint get_viewport_y
|
|
3137
|
+
"value": "```fallout-ssl-tooltip\nint get_viewport_y\n```"
|
|
3138
3138
|
}
|
|
3139
3139
|
},
|
|
3140
3140
|
"get_year": {
|
|
@@ -3158,7 +3158,7 @@
|
|
|
3158
3158
|
"input_funcs_available": {
|
|
3159
3159
|
"contents": {
|
|
3160
3160
|
"kind": "markdown",
|
|
3161
|
-
"value": "```fallout-ssl-tooltip\nint input_funcs_available
|
|
3161
|
+
"value": "```fallout-ssl-tooltip\nint input_funcs_available\n```\n(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."
|
|
3162
3162
|
}
|
|
3163
3163
|
},
|
|
3164
3164
|
"mark_movie_played": {
|
|
@@ -3182,13 +3182,13 @@
|
|
|
3182
3182
|
"nb_create_char": {
|
|
3183
3183
|
"contents": {
|
|
3184
3184
|
"kind": "markdown",
|
|
3185
|
-
"value": "```fallout-ssl-tooltip\nint nb_create_char
|
|
3185
|
+
"value": "```fallout-ssl-tooltip\nint nb_create_char\n```\n(DEPRECATED) Reserved for the brotherhood tactical training mod, and should be avoided. Not implemented, always returns 0."
|
|
3186
3186
|
}
|
|
3187
3187
|
},
|
|
3188
3188
|
"resume_game": {
|
|
3189
3189
|
"contents": {
|
|
3190
3190
|
"kind": "markdown",
|
|
3191
|
-
"value": "```fallout-ssl-tooltip\nvoid resume_game
|
|
3191
|
+
"value": "```fallout-ssl-tooltip\nvoid resume_game\n```"
|
|
3192
3192
|
}
|
|
3193
3193
|
},
|
|
3194
3194
|
"set_base_hit_chance_mod": {
|
|
@@ -3260,7 +3260,7 @@
|
|
|
3260
3260
|
"set_pipboy_available": {
|
|
3261
3261
|
"contents": {
|
|
3262
3262
|
"kind": "markdown",
|
|
3263
|
-
"value": "```fallout-ssl-tooltip\nvoid set_pipboy_available(int available)\n```\nSets the availability of the pipboy in the game. Use 0 to disable the pipboy, and 1 or 2 to enable it (value 2 does not
|
|
3263
|
+
"value": "```fallout-ssl-tooltip\nvoid set_pipboy_available(int available)\n```\nSets the availability of the pipboy in the game. Use 0 to disable the pipboy, and 1 or 2 to enable it (value 2 does not change the player's default appearance).\n- The availability state will be reset each time the player reloads the game.\n- __NOTE:__ starting from sfall 4.4.6/3.8.46, value 1 no longer marks the `VSUIT_MOVIE` movie as \"played\". Use `mark_movie_played(VSUIT_MOVIE)` instead if you want the old behavior.\n"
|
|
3264
3264
|
}
|
|
3265
3265
|
},
|
|
3266
3266
|
"set_proto_data": {
|
|
@@ -3314,7 +3314,7 @@
|
|
|
3314
3314
|
"stop_game": {
|
|
3315
3315
|
"contents": {
|
|
3316
3316
|
"kind": "markdown",
|
|
3317
|
-
"value": "```fallout-ssl-tooltip\nvoid stop_game
|
|
3317
|
+
"value": "```fallout-ssl-tooltip\nvoid stop_game\n```"
|
|
3318
3318
|
}
|
|
3319
3319
|
},
|
|
3320
3320
|
"toggle_active_hand": {
|
|
@@ -3338,7 +3338,7 @@
|
|
|
3338
3338
|
"outlined_object": {
|
|
3339
3339
|
"contents": {
|
|
3340
3340
|
"kind": "markdown",
|
|
3341
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr outlined_object
|
|
3341
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr outlined_object\n```\nReturns an object that is currently highlighted by hovering the mouse above it."
|
|
3342
3342
|
}
|
|
3343
3343
|
},
|
|
3344
3344
|
"set_outline": {
|
|
@@ -3362,7 +3362,7 @@
|
|
|
3362
3362
|
"clear_selectable_perks": {
|
|
3363
3363
|
"contents": {
|
|
3364
3364
|
"kind": "markdown",
|
|
3365
|
-
"value": "```fallout-ssl-tooltip\nvoid clear_selectable_perks
|
|
3365
|
+
"value": "```fallout-ssl-tooltip\nvoid clear_selectable_perks\n```\nRestores the \"select a perk\" box to its default state."
|
|
3366
3366
|
}
|
|
3367
3367
|
},
|
|
3368
3368
|
"get_perk_available": {
|
|
@@ -3392,7 +3392,7 @@
|
|
|
3392
3392
|
"hide_real_perks": {
|
|
3393
3393
|
"contents": {
|
|
3394
3394
|
"kind": "markdown",
|
|
3395
|
-
"value": "```fallout-ssl-tooltip\nvoid hide_real_perks
|
|
3395
|
+
"value": "```fallout-ssl-tooltip\nvoid hide_real_perks\n```\nPrevent the \"select a perk\" box from displaying any of the original 119 perks."
|
|
3396
3396
|
}
|
|
3397
3397
|
},
|
|
3398
3398
|
"perk_add_mode": {
|
|
@@ -3584,7 +3584,7 @@
|
|
|
3584
3584
|
"show_real_perks": {
|
|
3585
3585
|
"contents": {
|
|
3586
3586
|
"kind": "markdown",
|
|
3587
|
-
"value": "```fallout-ssl-tooltip\nvoid show_real_perks
|
|
3587
|
+
"value": "```fallout-ssl-tooltip\nvoid show_real_perks\n```\nReverts the effect os `hide_real_perks`."
|
|
3588
3588
|
}
|
|
3589
3589
|
},
|
|
3590
3590
|
"set_quest_failure_value": {
|
|
@@ -3752,7 +3752,7 @@
|
|
|
3752
3752
|
"get_available_skill_points": {
|
|
3753
3753
|
"contents": {
|
|
3754
3754
|
"kind": "markdown",
|
|
3755
|
-
"value": "```fallout-ssl-tooltip\nint get_available_skill_points
|
|
3755
|
+
"value": "```fallout-ssl-tooltip\nint get_available_skill_points\n```"
|
|
3756
3756
|
}
|
|
3757
3757
|
},
|
|
3758
3758
|
"get_critter_skill_points": {
|
|
@@ -3926,7 +3926,7 @@
|
|
|
3926
3926
|
"add_iface_tag": {
|
|
3927
3927
|
"contents": {
|
|
3928
3928
|
"kind": "markdown",
|
|
3929
|
-
"value": "```fallout-ssl-tooltip\nvoid add_iface_tag
|
|
3929
|
+
"value": "```fallout-ssl-tooltip\nvoid add_iface_tag\n```\nAdds one custom box to the current boxes, and returns the number of the added tag (-1 if the tags limit is exceeded. The maximum number of boxes is limited to 126 tags.\n`show_iface_tag`, `hide_iface_tag` and `is_iface_tag_active` relate to the boxes that appear above the interface such as SNEAK and LEVEL. You can use 0 for **SNEAK** (starting from sfall 4.4.4/3.8.44), 3 for **LEVEL**, 4 for **ADDICT**, and 5 to (4 + the value of BoxBarCount in `ddraw.ini`) for custom boxes. Remember to add your messages to `intrface.msg` and set up the font colours in `ddraw.ini` if you're going to use custom boxes. Starting from sfall 4.1/3.8.12, `is_iface_tag_active` can also be used to check 0 for **SNEAK**, 1 for **POISONED**, and 2 for **RADIATED**.\n"
|
|
3930
3930
|
}
|
|
3931
3931
|
},
|
|
3932
3932
|
"hide_iface_tag": {
|
|
@@ -4010,7 +4010,7 @@
|
|
|
4010
4010
|
"tile_refresh_display": {
|
|
4011
4011
|
"contents": {
|
|
4012
4012
|
"kind": "markdown",
|
|
4013
|
-
"value": "```fallout-ssl-tooltip\nvoid tile_refresh_display
|
|
4013
|
+
"value": "```fallout-ssl-tooltip\nvoid tile_refresh_display\n```\nRedraws the game scene (tiles, walls, objects, etc.)."
|
|
4014
4014
|
}
|
|
4015
4015
|
},
|
|
4016
4016
|
"tile_under_cursor": {
|
|
@@ -4046,19 +4046,19 @@
|
|
|
4046
4046
|
"sfall_ver_build": {
|
|
4047
4047
|
"contents": {
|
|
4048
4048
|
"kind": "markdown",
|
|
4049
|
-
"value": "```fallout-ssl-tooltip\nint sfall_ver_build
|
|
4049
|
+
"value": "```fallout-ssl-tooltip\nint sfall_ver_build\n```"
|
|
4050
4050
|
}
|
|
4051
4051
|
},
|
|
4052
4052
|
"sfall_ver_major": {
|
|
4053
4053
|
"contents": {
|
|
4054
4054
|
"kind": "markdown",
|
|
4055
|
-
"value": "```fallout-ssl-tooltip\nint sfall_ver_major
|
|
4055
|
+
"value": "```fallout-ssl-tooltip\nint sfall_ver_major\n```"
|
|
4056
4056
|
}
|
|
4057
4057
|
},
|
|
4058
4058
|
"sfall_ver_minor": {
|
|
4059
4059
|
"contents": {
|
|
4060
4060
|
"kind": "markdown",
|
|
4061
|
-
"value": "```fallout-ssl-tooltip\nint sfall_ver_minor
|
|
4061
|
+
"value": "```fallout-ssl-tooltip\nint sfall_ver_minor\n```"
|
|
4062
4062
|
}
|
|
4063
4063
|
},
|
|
4064
4064
|
"fs_copy": {
|
|
@@ -4226,7 +4226,7 @@
|
|
|
4226
4226
|
"get_window_under_mouse": {
|
|
4227
4227
|
"contents": {
|
|
4228
4228
|
"kind": "markdown",
|
|
4229
|
-
"value": "```fallout-ssl-tooltip\nint get_window_under_mouse
|
|
4229
|
+
"value": "```fallout-ssl-tooltip\nint get_window_under_mouse\n```\nReturns the internal ID of the top-most window under mouse cursor."
|
|
4230
4230
|
}
|
|
4231
4231
|
},
|
|
4232
4232
|
"interface_art_draw": {
|
|
@@ -4268,13 +4268,13 @@
|
|
|
4268
4268
|
"get_world_map_x_pos": {
|
|
4269
4269
|
"contents": {
|
|
4270
4270
|
"kind": "markdown",
|
|
4271
|
-
"value": "```fallout-ssl-tooltip\nint get_world_map_x_pos
|
|
4271
|
+
"value": "```fallout-ssl-tooltip\nint get_world_map_x_pos\n```\nThe mapper manual lists the functions `world_map_x_pos` and `world_map_y_pos`, which supposedly return the player's x and y positions on the world map. `get_world_map_x/y_pos` are included here anyway, because I was unable to get those original functions to work, or even to find any evidence that they existed in game."
|
|
4272
4272
|
}
|
|
4273
4273
|
},
|
|
4274
4274
|
"get_world_map_y_pos": {
|
|
4275
4275
|
"contents": {
|
|
4276
4276
|
"kind": "markdown",
|
|
4277
|
-
"value": "```fallout-ssl-tooltip\nint get_world_map_y_pos
|
|
4277
|
+
"value": "```fallout-ssl-tooltip\nint get_world_map_y_pos\n```\nThe mapper manual lists the functions `world_map_x_pos` and `world_map_y_pos`, which supposedly return the player's x and y positions on the world map. `get_world_map_x/y_pos` are included here anyway, because I was unable to get those original functions to work, or even to find any evidence that they existed in game."
|
|
4278
4278
|
}
|
|
4279
4279
|
},
|
|
4280
4280
|
"set_world_map_pos": {
|