@bgforge/mls-server 3.16.2 → 3.18.0
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 +3 -2
- package/out/compile-worker.js +10 -8
- package/out/completion.fallout-ssl.json +187 -207
- package/out/completion.weidu-baf.json +4 -4
- package/out/completion.weidu-tp2.json +231 -121
- package/out/server.js +252 -245
- package/out/signature.fallout-ssl.json +14062 -8
- package/out/td-plugin.js +1 -1
- package/out/tree-sitter-baf.wasm +0 -0
- package/out/tree-sitter-fallout_msg.wasm +0 -0
- package/out/tree-sitter-ssl.wasm +0 -0
- package/out/tree-sitter-weidu_d.wasm +0 -0
- package/out/tree-sitter-weidu_tp2.wasm +0 -0
- package/out/tree-sitter-weidu_tra.wasm +0 -0
- package/out/ts-morph-worker.js +190 -190
- package/out/web-tree-sitter.wasm +0 -0
- package/package.json +16 -12
- package/out/fallout-ssl-engine-proc-docs.json +0 -29
- package/out/fallout-ssl-engine-procedures.json +0 -29
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"category": "base_functions",
|
|
7
7
|
"documentation": {
|
|
8
8
|
"kind": "markdown",
|
|
9
|
-
"value": "```fallout-ssl-tooltip\nvoid AddNamedEvent(ObjectPtr name, Procedure proc)\n```\nAdds named handler (proc) for event (name). Can be signaled only once, and removed afterwards."
|
|
9
|
+
"value": "```fallout-ssl-tooltip\nvoid AddNamedEvent(ObjectPtr name, Procedure proc)\n```\n|||\n|:-|:-|\n|`name`| Event name; signaled once, then removed|\n|`proc`| Procedure called when the event is signaled|\n\nAdds named handler (proc) for event (name). Can be signaled only once, and removed afterwards."
|
|
10
10
|
}
|
|
11
11
|
},
|
|
12
12
|
{
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"category": "base_functions",
|
|
17
17
|
"documentation": {
|
|
18
18
|
"kind": "markdown",
|
|
19
|
-
"value": "```fallout-ssl-tooltip\nvoid AddNamedHandler(ObjectPtr name, Procedure proc)\n```\nAdds named handler (proc) for event (name). Can be signaled many times."
|
|
19
|
+
"value": "```fallout-ssl-tooltip\nvoid AddNamedHandler(ObjectPtr name, Procedure proc)\n```\n|||\n|:-|:-|\n|`name`| Event name; the handler can be signaled many times|\n|`proc`| Procedure called each time the event is signaled|\n\nAdds named handler (proc) for event (name). Can be signaled many times."
|
|
20
20
|
}
|
|
21
21
|
},
|
|
22
22
|
{
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"category": "base_functions",
|
|
27
27
|
"documentation": {
|
|
28
28
|
"kind": "markdown",
|
|
29
|
-
"value": "```fallout-ssl-tooltip\nvoid ClearNamed(string event)\n```\nRemoves all handlers for named event."
|
|
29
|
+
"value": "```fallout-ssl-tooltip\nvoid ClearNamed(string event)\n```\n|||\n|:-|:-|\n|`event`| Event name whose handlers are all removed|\n\nRemoves all handlers for named event."
|
|
30
30
|
}
|
|
31
31
|
},
|
|
32
32
|
{
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"category": "base_functions",
|
|
37
37
|
"documentation": {
|
|
38
38
|
"kind": "markdown",
|
|
39
|
-
"value": "```fallout-ssl-tooltip\nvoid SignalNamed(string event)\n```\nCalls events and/or handler for given name (event). See AddNamedEvent and AddNamedHandler to add handlers. This basically just calls the appropriate procedures."
|
|
39
|
+
"value": "```fallout-ssl-tooltip\nvoid SignalNamed(string event)\n```\n|||\n|:-|:-|\n|`event`| Event name whose handlers and events are called|\n\nCalls events and/or handler for given name (event). See AddNamedEvent and AddNamedHandler to add handlers. This basically just calls the appropriate procedures."
|
|
40
40
|
}
|
|
41
41
|
},
|
|
42
42
|
{
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
"category": "base_functions",
|
|
57
57
|
"documentation": {
|
|
58
58
|
"kind": "markdown",
|
|
59
|
-
"value": "```fallout-ssl-tooltip\nvoid add_mult_objs_to_inven(ObjectPtr who, ObjectPtr item, int count)\n```\nAdds (count) instances of an object (item) to another object's (who's) inventory. Note that this only works with objects of type Item."
|
|
59
|
+
"value": "```fallout-ssl-tooltip\nvoid add_mult_objs_to_inven(ObjectPtr who, ObjectPtr item, int count)\n```\n|||\n|:-|:-|\n|`who`| Object whose inventory receives the items|\n|`item`| Item object to add; must be of type Item|\n|`count`| Number of instances to add|\n\nAdds (count) instances of an object (item) to another object's (who's) inventory. Note that this only works with objects of type Item."
|
|
60
60
|
}
|
|
61
61
|
},
|
|
62
62
|
{
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"category": "base_functions",
|
|
67
67
|
"documentation": {
|
|
68
68
|
"kind": "markdown",
|
|
69
|
-
"value": "```fallout-ssl-tooltip\nvoid add_obj_to_inven(ObjectPtr who, ObjectPtr item)\n```\nAdds an object (item) to another object's (who's) inventory. Note that this only works with objects of type Item."
|
|
69
|
+
"value": "```fallout-ssl-tooltip\nvoid add_obj_to_inven(ObjectPtr who, ObjectPtr item)\n```\n|||\n|:-|:-|\n|`who`| Object whose inventory receives the item|\n|`item`| Item object to add; must be of type Item|\n\nAdds an object (item) to another object's (who's) inventory. Note that this only works with objects of type Item."
|
|
70
70
|
}
|
|
71
71
|
},
|
|
72
72
|
{
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
"category": "base_functions",
|
|
77
77
|
"documentation": {
|
|
78
78
|
"kind": "markdown",
|
|
79
|
-
"value": "```fallout-ssl-tooltip\nvoid add_timer_event(ObjectPtr obj, int time, int info)\n```\nAdds a timed event call to the queue, at a given time offset, to call an object's (obj) script. Info is used to let scripts differentiate between timed event calls so that they can be hooked in multiple times. Info is read back by the script using the fixed_param operator. Note that time is in ticks (you can use game_ticks(seconds_num) to get the time in ticks from time in seconds)."
|
|
79
|
+
"value": "```fallout-ssl-tooltip\nvoid add_timer_event(ObjectPtr obj, int time, int info)\n```\n|||\n|:-|:-|\n|`obj`| Object whose script is called when the timer fires|\n|`time`| Delay in game ticks; `game_ticks(seconds)` converts seconds|\n|`info`| Value that tells timed calls apart; read back in the script with `fixed_param`|\n\nAdds a timed event call to the queue, at a given time offset, to call an object's (obj) script. Info is used to let scripts differentiate between timed event calls so that they can be hooked in multiple times. Info is read back by the script using the fixed_param operator. Note that time is in ticks (you can use game_ticks(seconds_num) to get the time in ticks from time in seconds)."
|
|
80
80
|
}
|
|
81
81
|
},
|
|
82
82
|
{
|
|
@@ -86,7 +86,7 @@
|
|
|
86
86
|
"category": "base_functions",
|
|
87
87
|
"documentation": {
|
|
88
88
|
"kind": "markdown",
|
|
89
|
-
"value": "```fallout-ssl-tooltip\nvoid anim(ObjectPtr who, int anim, int direction)\n```\nSets up a single-frame animation (anim) for the object (who) that runs in the given direction."
|
|
89
|
+
"value": "```fallout-ssl-tooltip\nvoid anim(ObjectPtr who, int anim, int direction)\n```\n|||\n|:-|:-|\n|`who`| Object to animate|\n|`anim`| Single-frame animation to play|\n|`direction`| Direction the animation runs in|\n\nSets up a single-frame animation (anim) for the object (who) that runs in the given direction."
|
|
90
90
|
}
|
|
91
91
|
},
|
|
92
92
|
{
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
"category": "base_functions",
|
|
97
97
|
"documentation": {
|
|
98
98
|
"kind": "markdown",
|
|
99
|
-
"value": "```fallout-ssl-tooltip\nint anim_action_frame(ObjectPtr who, int frame)\n```\nReturns the action frame of the given art frame on a given object (who). This can be used as the delay in an animation registration sequence."
|
|
99
|
+
"value": "```fallout-ssl-tooltip\nint anim_action_frame(ObjectPtr who, int frame)\n```\n|||\n|:-|:-|\n|`who`| Object whose art is queried|\n|`frame`| Art frame whose action frame is returned|\n\nReturns the action frame of the given art frame on a given object (who). This can be used as the delay in an animation registration sequence."
|
|
100
100
|
}
|
|
101
101
|
},
|
|
102
102
|
{
|
|
@@ -106,7 +106,7 @@
|
|
|
106
106
|
"category": "base_functions",
|
|
107
107
|
"documentation": {
|
|
108
108
|
"kind": "markdown",
|
|
109
|
-
"value": "```fallout-ssl-tooltip\nbool anim_busy(ObjectPtr who)\n```\nReturns True if object (who) is currently animating, otherwise False. This can be used to determine if a given object has completed an animation."
|
|
109
|
+
"value": "```fallout-ssl-tooltip\nbool anim_busy(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Object checked for a running animation|\n\nReturns True if object (who) is currently animating, otherwise False. This can be used to determine if a given object has completed an animation."
|
|
110
110
|
}
|
|
111
111
|
},
|
|
112
112
|
{
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
"category": "base_functions",
|
|
117
117
|
"documentation": {
|
|
118
118
|
"kind": "markdown",
|
|
119
|
-
"value": "```fallout-ssl-tooltip\nvoid animate_move_obj_to_tile(ObjectPtr who, int tile, int speed)\n```\nSets up an animation for a critter (who) to walk to a given tile (hex) at a given speed (speed). Speed (walk/run) can also have a flag attached (see define.h) to force the object (who) to stop it's current animation (for instance, if it was already walking somewhere) and then walk/run to the new location (tile)."
|
|
119
|
+
"value": "```fallout-ssl-tooltip\nvoid animate_move_obj_to_tile(ObjectPtr who, int tile, int speed)\n```\n|||\n|:-|:-|\n|`who`| Critter that walks or runs|\n|`tile`| Destination hex tile number|\n|`speed`| `ANIMATE_WALK` or `ANIMATE_RUN` from `animcomd.h`; add `ANIMATE_INTERRUPT` (or use `ANIMATE_RUN_FORCE`) to cancel the current animation first|\n\nSets up an animation for a critter (who) to walk to a given tile (hex) at a given speed (speed). Speed (walk/run) can also have a flag attached (see define.h) to force the object (who) to stop it's current animation (for instance, if it was already walking somewhere) and then walk/run to the new location (tile)."
|
|
120
120
|
}
|
|
121
121
|
},
|
|
122
122
|
{
|
|
@@ -126,7 +126,7 @@
|
|
|
126
126
|
"category": "base_functions",
|
|
127
127
|
"documentation": {
|
|
128
128
|
"kind": "markdown",
|
|
129
|
-
"value": "```fallout-ssl-tooltip\nvoid animate_rotation(int direction)\n```\n(Fallout 2 only) Changes the orientation (facing) of the self-object to the given direction (0-5)."
|
|
129
|
+
"value": "```fallout-ssl-tooltip\nvoid animate_rotation(int direction)\n```\n|||\n|:-|:-|\n|`direction`| Direction to face, 0-5|\n\n(Fallout 2 only) Changes the orientation (facing) of the self-object to the given direction (0-5)."
|
|
130
130
|
}
|
|
131
131
|
},
|
|
132
132
|
{
|
|
@@ -136,7 +136,7 @@
|
|
|
136
136
|
"category": "base_functions",
|
|
137
137
|
"documentation": {
|
|
138
138
|
"kind": "markdown",
|
|
139
|
-
"value": "```fallout-ssl-tooltip\nvoid animate_run_to_tile(int tile)\n```\n(Fallout 2 only) Sets up an animation for the self-object to RUN to a given tile (hex)."
|
|
139
|
+
"value": "```fallout-ssl-tooltip\nvoid animate_run_to_tile(int tile)\n```\n|||\n|:-|:-|\n|`tile`| Destination hex tile number|\n\n(Fallout 2 only) Sets up an animation for the self-object to RUN to a given tile (hex)."
|
|
140
140
|
}
|
|
141
141
|
},
|
|
142
142
|
{
|
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
"category": "base_functions",
|
|
147
147
|
"documentation": {
|
|
148
148
|
"kind": "markdown",
|
|
149
|
-
"value": "```fallout-ssl-tooltip\nvoid animate_set_frame(int newFrame)\n```\nChanges the current animation frame of the self-object to the given frame # (newFrame). This can be used to make lights go to broken lights or to alarm/siren lights, for example. Should be used in place of animate_stand for 2-frame anims."
|
|
149
|
+
"value": "```fallout-ssl-tooltip\nvoid animate_set_frame(int newFrame)\n```\n|||\n|:-|:-|\n|`newFrame`| Animation frame number to switch to|\n\nChanges the current animation frame of the self-object to the given frame # (newFrame). This can be used to make lights go to broken lights or to alarm/siren lights, for example. Should be used in place of animate_stand for 2-frame anims."
|
|
150
150
|
}
|
|
151
151
|
},
|
|
152
152
|
{
|
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
"category": "base_functions",
|
|
187
187
|
"documentation": {
|
|
188
188
|
"kind": "markdown",
|
|
189
|
-
"value": "```fallout-ssl-tooltip\nvoid animate_stand_reverse_obj(ObjectPtr obj)\n```\nSets up an animation for an object (obj) to run it's stand animation in reverse. This is used only for non-critters, to cause them to close (close doors, open containers, etc.)"
|
|
189
|
+
"value": "```fallout-ssl-tooltip\nvoid animate_stand_reverse_obj(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Non-critter object (door, container) to animate closing|\n\nSets up an animation for an object (obj) to run it's stand animation in reverse. This is used only for non-critters, to cause them to close (close doors, open containers, etc.)"
|
|
190
190
|
}
|
|
191
191
|
},
|
|
192
192
|
{
|
|
@@ -196,7 +196,7 @@
|
|
|
196
196
|
"category": "base_functions",
|
|
197
197
|
"documentation": {
|
|
198
198
|
"kind": "markdown",
|
|
199
|
-
"value": "```fallout-ssl-tooltip\nint art_anim(int fid)\n```\nReturns the animation that this fid represents (ANIM_stand, ANIM_pickup, etc.)"
|
|
199
|
+
"value": "```fallout-ssl-tooltip\nint art_anim(int fid)\n```\n|||\n|:-|:-|\n|`fid`| Frame ID (FID) of the art|\n\nReturns the animation that this fid represents (ANIM_stand, ANIM_pickup, etc.)"
|
|
200
200
|
}
|
|
201
201
|
},
|
|
202
202
|
{
|
|
@@ -206,7 +206,7 @@
|
|
|
206
206
|
"category": "base_functions",
|
|
207
207
|
"documentation": {
|
|
208
208
|
"kind": "markdown",
|
|
209
|
-
"value": "```fallout-ssl-tooltip\nvoid attack(ObjectPtr who)\n```\nCauses the focused object (self) to attempt to attack an object (who). This is a macro to attack_complex()."
|
|
209
|
+
"value": "```fallout-ssl-tooltip\nvoid attack(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Object to attack|\n\nCauses the focused object (self) to attempt to attack an object (who). This is a macro to attack_complex()."
|
|
210
210
|
}
|
|
211
211
|
},
|
|
212
212
|
{
|
|
@@ -216,7 +216,7 @@
|
|
|
216
216
|
"category": "base_functions",
|
|
217
217
|
"documentation": {
|
|
218
218
|
"kind": "markdown",
|
|
219
|
-
"value": "```fallout-ssl-tooltip\nvoid attack_complex(ObjectPtr who, int called_shot, int num_attacks, int bonus, int min_damage, int max_damage, int attacker_results, int target_results)\n```\nCauses the current object (self - must be a critter) to attempt to attack a critter (who) with various parameters modifying the combat: called_shot - 0/1/specific means none/random/specific (head, torso, etc.) num_attacks - the # of extra attacks the self object gets before the target bonus - the bonus to hit the target on the first turn only min_damage - the minimum damage that will be done the first attack max_damage - the maximum damage that will be done the first attack attacker_results - what state the attacker ends in after the first attack target_results - what state the target ends in after the first attack"
|
|
219
|
+
"value": "```fallout-ssl-tooltip\nvoid attack_complex(ObjectPtr who, int called_shot, int num_attacks, int bonus, int min_damage, int max_damage, int attacker_results, int target_results)\n```\n|||\n|:-|:-|\n|`who`| Critter to attack|\n|`called_shot`| 0 = none, 1 = random, otherwise a specific body part|\n|`num_attacks`| Extra attacks the self object gets before the target|\n|`bonus`| Bonus to hit the target on the first turn only|\n|`min_damage`| Minimum damage of the first attack|\n|`max_damage`| Maximum damage of the first attack|\n|`attacker_results`| State the attacker ends in after the first attack|\n|`target_results`| State the target ends in after the first attack|\n\nCauses the current object (self - must be a critter) to attempt to attack a critter (who) with various parameters modifying the combat: called_shot - 0/1/specific means none/random/specific (head, torso, etc.) num_attacks - the # of extra attacks the self object gets before the target bonus - the bonus to hit the target on the first turn only min_damage - the minimum damage that will be done the first attack max_damage - the maximum damage that will be done the first attack attacker_results - what state the attacker ends in after the first attack target_results - what state the target ends in after the first attack"
|
|
220
220
|
}
|
|
221
221
|
},
|
|
222
222
|
{
|
|
@@ -226,7 +226,7 @@
|
|
|
226
226
|
"category": "base_functions",
|
|
227
227
|
"documentation": {
|
|
228
228
|
"kind": "markdown",
|
|
229
|
-
"value": "```fallout-ssl-tooltip\nvoid attack_setup(ObjectPtr who, ObjectPtr victim)\n```\nSets up an attack from who on victim, without expecting this script to be involved. Can be used to setup attacks on critters from the map script."
|
|
229
|
+
"value": "```fallout-ssl-tooltip\nvoid attack_setup(ObjectPtr who, ObjectPtr victim)\n```\n|||\n|:-|:-|\n|`who`| Attacking critter|\n|`victim`| Critter being attacked|\n\nSets up an attack from who on victim, without expecting this script to be involved. Can be used to setup attacks on critters from the map script."
|
|
230
230
|
}
|
|
231
231
|
},
|
|
232
232
|
{
|
|
@@ -246,7 +246,7 @@
|
|
|
246
246
|
"category": "base_functions",
|
|
247
247
|
"documentation": {
|
|
248
248
|
"kind": "markdown",
|
|
249
|
-
"value": "```fallout-ssl-tooltip\nint car_give_gas(int amount)\n```\n(Fallout 2 only) Gives the car a given amount of gas."
|
|
249
|
+
"value": "```fallout-ssl-tooltip\nint car_give_gas(int amount)\n```\n|||\n|:-|:-|\n|`amount`| Amount of gas added to the car|\n\n(Fallout 2 only) Gives the car a given amount of gas."
|
|
250
250
|
}
|
|
251
251
|
},
|
|
252
252
|
{
|
|
@@ -286,7 +286,7 @@
|
|
|
286
286
|
"category": "base_functions",
|
|
287
287
|
"documentation": {
|
|
288
288
|
"kind": "markdown",
|
|
289
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr create_object(int pid, int tile_num, int elev)\n```\nCreates a new object of prototype (pid), placing it at a given tile number and at a given elevation (0-2). If the prototype indicates a script should be attached, then it will be."
|
|
289
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr create_object(int pid, int tile_num, int elev)\n```\n|||\n|:-|:-|\n|`pid`| Prototype ID of the object to create|\n|`tile_num`| Hex tile number to place it at|\n|`elev`| Elevation, 0-2|\n\nCreates a new object of prototype (pid), placing it at a given tile number and at a given elevation (0-2). If the prototype indicates a script should be attached, then it will be."
|
|
290
290
|
}
|
|
291
291
|
},
|
|
292
292
|
{
|
|
@@ -296,7 +296,7 @@
|
|
|
296
296
|
"category": "base_functions",
|
|
297
297
|
"documentation": {
|
|
298
298
|
"kind": "markdown",
|
|
299
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr create_object_sid(int pid, int tile_num, int elev, int sid)\n```\nCreates a new object of prototype (pid), placing it at a given tile # and at a given elevation (0-2). If sid is not -1, then it indicates that the default script should be overriden by this new script #."
|
|
299
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr create_object_sid(int pid, int tile_num, int elev, int sid)\n```\n|||\n|:-|:-|\n|`pid`| Prototype ID of the object to create|\n|`tile_num`| Hex tile number to place it at|\n|`elev`| Elevation, 0-2|\n|`sid`| Script ID overriding the prototype's default script; -1 keeps the default|\n\nCreates a new object of prototype (pid), placing it at a given tile # and at a given elevation (0-2). If sid is not -1, then it indicates that the default script should be overriden by this new script #."
|
|
300
300
|
}
|
|
301
301
|
},
|
|
302
302
|
{
|
|
@@ -306,7 +306,7 @@
|
|
|
306
306
|
"category": "base_functions",
|
|
307
307
|
"documentation": {
|
|
308
308
|
"kind": "markdown",
|
|
309
|
-
"value": "```fallout-ssl-tooltip\nint critter_add_trait(ObjectPtr who, int trait_type, int trait, int amount)\n```\nAdds a particular trait (trait) of a given type (trait_type) to a particular critter (who). Possible traits under the SPECIAL system are limited to Perks, Traits, Object-instance information (such as team #'s, ai-packet #'s, etc.)"
|
|
309
|
+
"value": "```fallout-ssl-tooltip\nint critter_add_trait(ObjectPtr who, int trait_type, int trait, int amount)\n```\n|||\n|:-|:-|\n|`who`| Critter receiving the trait|\n|`trait_type`| `TRAIT_PERK` or `TRAIT_OBJECT` from `define_pre.h`|\n|`trait`| For `TRAIT_PERK` a perk id; for `TRAIT_OBJECT` `OBJECT_AI_PACKET` or `OBJECT_TEAM_NUM` from `define.h`|\n\nAdds a particular trait (trait) of a given type (trait_type) to a particular critter (who). Possible traits under the SPECIAL system are limited to Perks, Traits, Object-instance information (such as team #'s, ai-packet #'s, etc.)"
|
|
310
310
|
}
|
|
311
311
|
},
|
|
312
312
|
{
|
|
@@ -316,7 +316,7 @@
|
|
|
316
316
|
"category": "base_functions",
|
|
317
317
|
"documentation": {
|
|
318
318
|
"kind": "markdown",
|
|
319
|
-
"value": "```fallout-ssl-tooltip\nint critter_attempt_placement(ObjectPtr who, int hex, int elev)\n```\nAttempts to place a critter at a given destination hex & elevation (0-2), if it fails, then it tries to find a nearby hex that is that is as near as possible to the start hex. No LONGER checks to see if the hex is visible on-screen."
|
|
319
|
+
"value": "```fallout-ssl-tooltip\nint critter_attempt_placement(ObjectPtr who, int hex, int elev)\n```\n|||\n|:-|:-|\n|`who`| Critter to place|\n|`hex`| Destination hex tile number; a nearby free hex is used if it is blocked|\n|`elev`| Destination elevation, 0-2|\n\nAttempts to place a critter at a given destination hex & elevation (0-2), if it fails, then it tries to find a nearby hex that is that is as near as possible to the start hex. No LONGER checks to see if the hex is visible on-screen."
|
|
320
320
|
}
|
|
321
321
|
},
|
|
322
322
|
{
|
|
@@ -326,7 +326,7 @@
|
|
|
326
326
|
"category": "base_functions",
|
|
327
327
|
"documentation": {
|
|
328
328
|
"kind": "markdown",
|
|
329
|
-
"value": "```fallout-ssl-tooltip\nvoid critter_damage(ObjectPtr who, int dmg_amount)\n```\n- Macro: `critter_dmg(who, amount, (DMG_normal_dam BWOR DMG_NOANIMATE))`\n- Inflicts damage on a critter (who) of a given amount, killing it if necessary. Normal damage, no animation."
|
|
329
|
+
"value": "```fallout-ssl-tooltip\nvoid critter_damage(ObjectPtr who, int dmg_amount)\n```\n|||\n|:-|:-|\n|`who`| Critter to damage|\n|`dmg_amount`| Amount of damage|\n\n- Macro: `critter_dmg(who, amount, (DMG_normal_dam BWOR DMG_NOANIMATE))`\n- Inflicts damage on a critter (who) of a given amount, killing it if necessary. Normal damage, no animation."
|
|
330
330
|
}
|
|
331
331
|
},
|
|
332
332
|
{
|
|
@@ -336,7 +336,7 @@
|
|
|
336
336
|
"category": "base_functions",
|
|
337
337
|
"documentation": {
|
|
338
338
|
"kind": "markdown",
|
|
339
|
-
"value": "```fallout-ssl-tooltip\nvoid critter_dmg(ObjectPtr who, int dmg_amount, int flags)\n```\nInflicts damage on a critter (who) of a given amount, killing it if necessary. Use `DMG_*` flags to customize behaviour."
|
|
339
|
+
"value": "```fallout-ssl-tooltip\nvoid critter_dmg(ObjectPtr who, int dmg_amount, int flags)\n```\n|||\n|:-|:-|\n|`who`| Critter to damage|\n|`dmg_amount`| Amount of damage|\n|`flags`| `DMG_*` damage type and flags from `define.h`, e.g. `DMG_NOANIMATE`|\n\nInflicts damage on a critter (who) of a given amount, killing it if necessary. Use `DMG_*` flags to customize behaviour."
|
|
340
340
|
}
|
|
341
341
|
},
|
|
342
342
|
{
|
|
@@ -346,7 +346,7 @@
|
|
|
346
346
|
"category": "base_functions",
|
|
347
347
|
"documentation": {
|
|
348
348
|
"kind": "markdown",
|
|
349
|
-
"value": "```fallout-ssl-tooltip\nint critter_heal(ObjectPtr who, int amount)\n```\nHeals a critter for a given amount (if given a value above their MaxHP will go up to their maximum HP). [Note: can also input negative amounts, causing the critter to be hurt for that amount. This is useful because it bypasses all resistances and thresholds"
|
|
349
|
+
"value": "```fallout-ssl-tooltip\nint critter_heal(ObjectPtr who, int amount)\n```\n|||\n|:-|:-|\n|`who`| Critter to heal|\n|`amount`| Hit points restored, capped at max HP; negative hurts, bypassing resistances and thresholds|\n\nHeals a critter for a given amount (if given a value above their MaxHP will go up to their maximum HP). [Note: can also input negative amounts, causing the critter to be hurt for that amount. This is useful because it bypasses all resistances and thresholds"
|
|
350
350
|
}
|
|
351
351
|
},
|
|
352
352
|
{
|
|
@@ -356,7 +356,7 @@
|
|
|
356
356
|
"category": "base_functions",
|
|
357
357
|
"documentation": {
|
|
358
358
|
"kind": "markdown",
|
|
359
|
-
"value": "```fallout-ssl-tooltip\nint critter_injure(ObjectPtr who, int how)\n```\nInjures a given critter (who) by crippling given limbs/body parts (defined by DAM_CRIP_ARM_LEFT, DAM_BLIND, etc. in define.h)"
|
|
359
|
+
"value": "```fallout-ssl-tooltip\nint critter_injure(ObjectPtr who, int how)\n```\n|||\n|:-|:-|\n|`who`| Critter to injure|\n|`how`| `DAM_CRIP_*` and `DAM_BLIND` flags from `define.h`|\n\nInjures a given critter (who) by crippling given limbs/body parts (defined by DAM_CRIP_ARM_LEFT, DAM_BLIND, etc. in define.h)"
|
|
360
360
|
}
|
|
361
361
|
},
|
|
362
362
|
{
|
|
@@ -366,7 +366,7 @@
|
|
|
366
366
|
"category": "base_functions",
|
|
367
367
|
"documentation": {
|
|
368
368
|
"kind": "markdown",
|
|
369
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr critter_inven_obj(ObjectPtr who, int where)\n```\nReturns a pointer to an object that is in a given spot (NULL if none).\nThe appropriate values for where are: `INVEN_TYPE_WORN`, `INVEN_TYPE_RIGHT_HAND`, and `INVEN_TYPE_LEFT_HAND`.\n\n**Deprecated:** Use `critter_inven_obj2` instead"
|
|
369
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr critter_inven_obj(ObjectPtr who, int where)\n```\n|||\n|:-|:-|\n|`who`| Critter whose inventory is read|\n|`where`| `INVEN_TYPE_WORN`, `INVEN_TYPE_RIGHT_HAND` or `INVEN_TYPE_LEFT_HAND` from `define.h`|\n\nReturns a pointer to an object that is in a given spot (NULL if none).\nThe appropriate values for where are: `INVEN_TYPE_WORN`, `INVEN_TYPE_RIGHT_HAND`, and `INVEN_TYPE_LEFT_HAND`.\n\n**Deprecated:** Use `critter_inven_obj2` instead"
|
|
370
370
|
},
|
|
371
371
|
"tags": [
|
|
372
372
|
1
|
|
@@ -379,7 +379,7 @@
|
|
|
379
379
|
"category": "base_functions",
|
|
380
380
|
"documentation": {
|
|
381
381
|
"kind": "markdown",
|
|
382
|
-
"value": "```fallout-ssl-tooltip\nint critter_is_fleeing(ObjectPtr who)\n```\nReturns True if the critter object (who) has its FLEE flag set."
|
|
382
|
+
"value": "```fallout-ssl-tooltip\nint critter_is_fleeing(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter checked for the FLEE flag|\n\nReturns True if the critter object (who) has its FLEE flag set."
|
|
383
383
|
}
|
|
384
384
|
},
|
|
385
385
|
{
|
|
@@ -399,7 +399,7 @@
|
|
|
399
399
|
"category": "base_functions",
|
|
400
400
|
"documentation": {
|
|
401
401
|
"kind": "markdown",
|
|
402
|
-
"value": "```fallout-ssl-tooltip\nint critter_rm_trait(ObjectPtr who, int trait_type, int trait, int amount)\n```\nRemoves a particular trait (trait) of a given type (trait_type) from a particular critter (who)."
|
|
402
|
+
"value": "```fallout-ssl-tooltip\nint critter_rm_trait(ObjectPtr who, int trait_type, int trait, int amount)\n```\n|||\n|:-|:-|\n|`who`| Critter losing the trait|\n|`trait_type`| `TRAIT_PERK` from `define_pre.h`; other kinds are not supported|\n|`trait`| Perk id to remove (all ranks are removed)|\n\nRemoves a particular trait (trait) of a given type (trait_type) from a particular critter (who)."
|
|
403
403
|
}
|
|
404
404
|
},
|
|
405
405
|
{
|
|
@@ -409,7 +409,7 @@
|
|
|
409
409
|
"category": "base_functions",
|
|
410
410
|
"documentation": {
|
|
411
411
|
"kind": "markdown",
|
|
412
|
-
"value": "```fallout-ssl-tooltip\nint critter_set_flee_state(ObjectPtr who, bool flee_on)\n```\nSets the FLEE flag on or off. This controls whether the critter flees during combat."
|
|
412
|
+
"value": "```fallout-ssl-tooltip\nint critter_set_flee_state(ObjectPtr who, bool flee_on)\n```\n|||\n|:-|:-|\n|`who`| Critter whose FLEE flag is set|\n|`flee_on`| 1 sets the FLEE flag, 0 clears it|\n\nSets the FLEE flag on or off. This controls whether the critter flees during combat."
|
|
413
413
|
}
|
|
414
414
|
},
|
|
415
415
|
{
|
|
@@ -419,7 +419,7 @@
|
|
|
419
419
|
"category": "base_functions",
|
|
420
420
|
"documentation": {
|
|
421
421
|
"kind": "markdown",
|
|
422
|
-
"value": "```fallout-ssl-tooltip\nint critter_skill_level(ObjectPtr who, int skillNum)\n```\nReturns the current skill level of a particular object's (who) skill (skillNum)."
|
|
422
|
+
"value": "```fallout-ssl-tooltip\nint critter_skill_level(ObjectPtr who, int skillNum)\n```\n|||\n|:-|:-|\n|`who`| Critter whose skill is read|\n|`skillNum`| `SKILL_*` from `define.h`|\n\nReturns the current skill level of a particular object's (who) skill (skillNum)."
|
|
423
423
|
}
|
|
424
424
|
},
|
|
425
425
|
{
|
|
@@ -429,7 +429,7 @@
|
|
|
429
429
|
"category": "base_functions",
|
|
430
430
|
"documentation": {
|
|
431
431
|
"kind": "markdown",
|
|
432
|
-
"value": "```fallout-ssl-tooltip\nint critter_state(ObjectPtr who)\n```\nReturns the state of a given critter object (from combat data), used to determine if a critter is dead, unconscious, etc."
|
|
432
|
+
"value": "```fallout-ssl-tooltip\nint critter_state(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter whose combat state is read|\n\nReturns the state of a given critter object (from combat data), used to determine if a critter is dead, unconscious, etc."
|
|
433
433
|
}
|
|
434
434
|
},
|
|
435
435
|
{
|
|
@@ -439,7 +439,7 @@
|
|
|
439
439
|
"category": "base_functions",
|
|
440
440
|
"documentation": {
|
|
441
441
|
"kind": "markdown",
|
|
442
|
-
"value": "```fallout-ssl-tooltip\nint critter_stop_attacking(ObjectPtr who)\n```\nFlags the critter object (who) as no longer wishing to be active in combat."
|
|
442
|
+
"value": "```fallout-ssl-tooltip\nint critter_stop_attacking(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter taken out of active combat|\n\nFlags the critter object (who) as no longer wishing to be active in combat."
|
|
443
443
|
}
|
|
444
444
|
},
|
|
445
445
|
{
|
|
@@ -479,7 +479,7 @@
|
|
|
479
479
|
"category": "base_functions",
|
|
480
480
|
"documentation": {
|
|
481
481
|
"kind": "markdown",
|
|
482
|
-
"value": "```fallout-ssl-tooltip\nvoid debug_msg(string text)\n```\nPrints a string to the debug monitor. Should be used exclusively for debug information, instead of display_msg()! The user will never see these messages unless they have debugging enabled and activated. If they have debugging enabled and DEBUGLOG set, the messages will only show up in debug.log file."
|
|
482
|
+
"value": "```fallout-ssl-tooltip\nvoid debug_msg(string text)\n```\n|||\n|:-|:-|\n|`text`| Text sent to the debug monitor; shown only with debugging enabled|\n\nPrints a string to the debug monitor. Should be used exclusively for debug information, instead of display_msg()! The user will never see these messages unless they have debugging enabled and activated. If they have debugging enabled and DEBUGLOG set, the messages will only show up in debug.log file."
|
|
483
483
|
}
|
|
484
484
|
},
|
|
485
485
|
{
|
|
@@ -489,7 +489,7 @@
|
|
|
489
489
|
"category": "base_functions",
|
|
490
490
|
"documentation": {
|
|
491
491
|
"kind": "markdown",
|
|
492
|
-
"value": "```fallout-ssl-tooltip\nint destroy_mult_objs(ObjectPtr item, int count)\n```\nDestroys count number of instances of an item object. This function will figure out which inventory this item is in (if it isn't on the ground). If it is on the ground, of course, there is only one instance of this object, so only one will be destroyed."
|
|
492
|
+
"value": "```fallout-ssl-tooltip\nint destroy_mult_objs(ObjectPtr item, int count)\n```\n|||\n|:-|:-|\n|`item`| Item object whose instances are destroyed|\n|`count`| Number of instances to destroy|\n\nDestroys count number of instances of an item object. This function will figure out which inventory this item is in (if it isn't on the ground). If it is on the ground, of course, there is only one instance of this object, so only one will be destroyed."
|
|
493
493
|
}
|
|
494
494
|
},
|
|
495
495
|
{
|
|
@@ -499,7 +499,7 @@
|
|
|
499
499
|
"category": "base_functions",
|
|
500
500
|
"documentation": {
|
|
501
501
|
"kind": "markdown",
|
|
502
|
-
"value": "```fallout-ssl-tooltip\nint destroy_object(ObjectPtr obj)\n```\nDestroys an object (obj), which will call its script in the destroy_proc section if the object is *NOT* the calling object."
|
|
502
|
+
"value": "```fallout-ssl-tooltip\nint destroy_object(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object to destroy; its `destroy_proc` runs unless it is the calling object|\n\nDestroys an object (obj), which will call its script in the destroy_proc section if the object is *NOT* the calling object."
|
|
503
503
|
}
|
|
504
504
|
},
|
|
505
505
|
{
|
|
@@ -539,7 +539,7 @@
|
|
|
539
539
|
"category": "base_functions",
|
|
540
540
|
"documentation": {
|
|
541
541
|
"kind": "markdown",
|
|
542
|
-
"value": "```fallout-ssl-tooltip\nvoid display_msg(string message)\n```\nDisplays a string on the in-game PDA display (lower-left hand corner)."
|
|
542
|
+
"value": "```fallout-ssl-tooltip\nvoid display_msg(string message)\n```\n|||\n|:-|:-|\n|`message`| Text shown in the message display in the lower-left|\n\nDisplays a string on the in-game PDA display (lower-left hand corner)."
|
|
543
543
|
}
|
|
544
544
|
},
|
|
545
545
|
{
|
|
@@ -549,7 +549,7 @@
|
|
|
549
549
|
"category": "base_functions",
|
|
550
550
|
"documentation": {
|
|
551
551
|
"kind": "markdown",
|
|
552
|
-
"value": "```fallout-ssl-tooltip\nint do_check(ObjectPtr who, int check, int modifier)\n```\nDo a check/test-roll versus one of the various basic traits (strength, perception, etc.). Note: these cannot generate Critical Success or Critical Failure as they are a basic X==Y check."
|
|
552
|
+
"value": "```fallout-ssl-tooltip\nint do_check(ObjectPtr who, int check, int modifier)\n```\n|||\n|:-|:-|\n|`who`| Critter whose stat is tested|\n|`check`| Base stat to test, `STAT_st` to `STAT_lu` from `define.h`|\n|`modifier`| Bonus or penalty added to the stat value before the roll|\n\nDo a check/test-roll versus one of the various basic traits (strength, perception, etc.). Note: these cannot generate Critical Success or Critical Failure as they are a basic X==Y check."
|
|
553
553
|
}
|
|
554
554
|
},
|
|
555
555
|
{
|
|
@@ -559,7 +559,7 @@
|
|
|
559
559
|
"category": "base_functions",
|
|
560
560
|
"documentation": {
|
|
561
561
|
"kind": "markdown",
|
|
562
|
-
"value": "```fallout-ssl-tooltip\
|
|
562
|
+
"value": "```fallout-ssl-tooltip\nvoid drop_obj(ObjectPtr obj)\n```\nCauses the critter self-object to remove a given object (obj) from it's inventory and place it on the ground at its hex. This animates the self_obj."
|
|
563
563
|
}
|
|
564
564
|
},
|
|
565
565
|
{
|
|
@@ -569,7 +569,7 @@
|
|
|
569
569
|
"category": "base_functions",
|
|
570
570
|
"documentation": {
|
|
571
571
|
"kind": "markdown",
|
|
572
|
-
"value": "```fallout-ssl-tooltip\nint drug_influence(ObjectPtr who)\n```\nReturns True if a given critter object (who) is currently under any drug influences, False otherwise."
|
|
572
|
+
"value": "```fallout-ssl-tooltip\nint drug_influence(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter checked for active drug effects|\n\nReturns True if a given critter object (who) is currently under any drug influences, False otherwise."
|
|
573
573
|
}
|
|
574
574
|
},
|
|
575
575
|
{
|
|
@@ -589,7 +589,7 @@
|
|
|
589
589
|
"category": "base_functions",
|
|
590
590
|
"documentation": {
|
|
591
591
|
"kind": "markdown",
|
|
592
|
-
"value": "```fallout-ssl-tooltip\nint elevation(ObjectPtr obj)\n```\nReturns object's elevation"
|
|
592
|
+
"value": "```fallout-ssl-tooltip\nint elevation(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object whose elevation is returned|\n\nReturns object's elevation"
|
|
593
593
|
}
|
|
594
594
|
},
|
|
595
595
|
{
|
|
@@ -649,7 +649,7 @@
|
|
|
649
649
|
"category": "base_functions",
|
|
650
650
|
"documentation": {
|
|
651
651
|
"kind": "markdown",
|
|
652
|
-
"value": "```fallout-ssl-tooltip\nvoid float_msg(ObjectPtr who, string message, int type)\n```\nAttempts to create a floating-text message (str) attached to an object (who) using colors dictated by type. There are two special types, WARNING and SEQUENTIAL. WARNING is used to print a message centered on the screen (such as for end-of-quest notifications), and SEQUENTIAL will cycle through the colors, in an attempt to give critters different-colored messages to differentiate them."
|
|
652
|
+
"value": "```fallout-ssl-tooltip\nvoid float_msg(ObjectPtr who, string message, int type)\n```\n|||\n|:-|:-|\n|`who`| Object the floating text is attached to|\n|`message`| Text to float|\n|`type`| `FLOAT_MSG_*` color from `define.h`; `FLOAT_MSG_WARNING` centers it on screen, `FLOAT_MSG_SEQUENTIAL` cycles colors|\n\nAttempts to create a floating-text message (str) attached to an object (who) using colors dictated by type. There are two special types, WARNING and SEQUENTIAL. WARNING is used to print a message centered on the screen (such as for end-of-quest notifications), and SEQUENTIAL will cycle through the colors, in an attempt to give critters different-colored messages to differentiate them."
|
|
653
653
|
}
|
|
654
654
|
},
|
|
655
655
|
{
|
|
@@ -659,7 +659,7 @@
|
|
|
659
659
|
"category": "base_functions",
|
|
660
660
|
"documentation": {
|
|
661
661
|
"kind": "markdown",
|
|
662
|
-
"value": "```fallout-ssl-tooltip\nint floor(int/float value)\n```\nWorks properly for positive values, but for negative ones functions like `ceil` (rounds up instead of down).\n\n**Deprecated:** Use `floor2` instead"
|
|
662
|
+
"value": "```fallout-ssl-tooltip\nint floor(int/float value)\n```\n|||\n|:-|:-|\n|`value`| Number to round down|\n\nWorks properly for positive values, but for negative ones functions like `ceil` (rounds up instead of down).\n\n**Deprecated:** Use `floor2` instead"
|
|
663
663
|
},
|
|
664
664
|
"tags": [
|
|
665
665
|
1
|
|
@@ -682,7 +682,7 @@
|
|
|
682
682
|
"category": "base_functions",
|
|
683
683
|
"documentation": {
|
|
684
684
|
"kind": "markdown",
|
|
685
|
-
"value": "```fallout-ssl-tooltip\nvoid gSay_Message(int msg_list, int msg_num, int reaction)\n```\nSets up a sayMessage, which is a reply with just a [Done] option. The msg_list determines which message file to look in, and the msg_num determines which line to use from the file."
|
|
685
|
+
"value": "```fallout-ssl-tooltip\nvoid gSay_Message(int msg_list, int msg_num, int reaction)\n```\n|||\n|:-|:-|\n|`msg_list`| Message file number to read from|\n|`msg_num`| Line number in that message file|\n|`reaction`| `GOOD_REACTION`, `NEUTRAL_REACTION` or `BAD_REACTION` from `define.h`|\n\nSets up a sayMessage, which is a reply with just a [Done] option. The msg_list determines which message file to look in, and the msg_num determines which line to use from the file."
|
|
686
686
|
}
|
|
687
687
|
},
|
|
688
688
|
{
|
|
@@ -692,7 +692,7 @@
|
|
|
692
692
|
"category": "base_functions",
|
|
693
693
|
"documentation": {
|
|
694
694
|
"kind": "markdown",
|
|
695
|
-
"value": "```fallout-ssl-tooltip\
|
|
695
|
+
"value": "```fallout-ssl-tooltip\nvoid gSay_Option(int msg_list, int msg_num, procedure target, int reaction)\n```\nSets up an option-choice for a reply block, getting the string from the message file (msg_list) and message number (msg_num), which will cause a given reaction (reaction), and if chosen will jump to the given (target) procedure."
|
|
696
696
|
}
|
|
697
697
|
},
|
|
698
698
|
{
|
|
@@ -702,7 +702,7 @@
|
|
|
702
702
|
"category": "base_functions",
|
|
703
703
|
"documentation": {
|
|
704
704
|
"kind": "markdown",
|
|
705
|
-
"value": "```fallout-ssl-tooltip\
|
|
705
|
+
"value": "```fallout-ssl-tooltip\nvoid gSay_Reply(int msg_list, int msg_num)\n```\nSets up a reply block (what the *CRITTER* says)."
|
|
706
706
|
}
|
|
707
707
|
},
|
|
708
708
|
{
|
|
@@ -722,7 +722,7 @@
|
|
|
722
722
|
"category": "base_functions",
|
|
723
723
|
"documentation": {
|
|
724
724
|
"kind": "markdown",
|
|
725
|
-
"value": "```fallout-ssl-tooltip\nint game_ticks(int seconds)\n```\nReturns the number of game ticks equal to a given # of seconds."
|
|
725
|
+
"value": "```fallout-ssl-tooltip\nint game_ticks(int seconds)\n```\n|||\n|:-|:-|\n|`seconds`| Time in seconds; 1 second is 10 ticks|\n\nReturns the number of game ticks equal to a given # of seconds."
|
|
726
726
|
}
|
|
727
727
|
},
|
|
728
728
|
{
|
|
@@ -742,7 +742,7 @@
|
|
|
742
742
|
"category": "base_functions",
|
|
743
743
|
"documentation": {
|
|
744
744
|
"kind": "markdown",
|
|
745
|
-
"value": "```fallout-ssl-tooltip\nvoid game_time_advance(int amount)\n```\nAdvances the current game time by (amount) ticks."
|
|
745
|
+
"value": "```fallout-ssl-tooltip\nvoid game_time_advance(int amount)\n```\n|||\n|:-|:-|\n|`amount`| Time to advance, in game ticks|\n\nAdvances the current game time by (amount) ticks."
|
|
746
746
|
}
|
|
747
747
|
},
|
|
748
748
|
{
|
|
@@ -812,7 +812,7 @@
|
|
|
812
812
|
"category": "base_functions",
|
|
813
813
|
"documentation": {
|
|
814
814
|
"kind": "markdown",
|
|
815
|
-
"value": "```fallout-ssl-tooltip\nint gdialog_mod_barter(int modifier)\n```\nTells the dialog system to switch to the barter screen, using a given modifier (+/- percent)."
|
|
815
|
+
"value": "```fallout-ssl-tooltip\nint gdialog_mod_barter(int modifier)\n```\n|||\n|:-|:-|\n|`modifier`| Barter price modifier in percent (+/-)|\n\nTells the dialog system to switch to the barter screen, using a given modifier (+/- percent)."
|
|
816
816
|
}
|
|
817
817
|
},
|
|
818
818
|
{
|
|
@@ -822,7 +822,7 @@
|
|
|
822
822
|
"category": "base_functions",
|
|
823
823
|
"documentation": {
|
|
824
824
|
"kind": "markdown",
|
|
825
|
-
"value": "```fallout-ssl-tooltip\nvoid gdialog_set_barter_mod(int modifier)\n```\nSets the current modifier for barter to a given percentage (modifier). Used to make barter easier/harder, even if the player initiates barter (as opposed to the script starting it.)"
|
|
825
|
+
"value": "```fallout-ssl-tooltip\nvoid gdialog_set_barter_mod(int modifier)\n```\n|||\n|:-|:-|\n|`modifier`| Barter price modifier in percent; makes barter easier or harder|\n\nSets the current modifier for barter to a given percentage (modifier). Used to make barter easier/harder, even if the player initiates barter (as opposed to the script starting it.)"
|
|
826
826
|
}
|
|
827
827
|
},
|
|
828
828
|
{
|
|
@@ -832,7 +832,7 @@
|
|
|
832
832
|
"category": "base_functions",
|
|
833
833
|
"documentation": {
|
|
834
834
|
"kind": "markdown",
|
|
835
|
-
"value": "```fallout-ssl-tooltip\nint get_critter_stat(ObjectPtr who, int stat)\n```\nReturns the value of a desired attribute/stat in a critter object (who)."
|
|
835
|
+
"value": "```fallout-ssl-tooltip\nint get_critter_stat(ObjectPtr who, int stat)\n```\n|||\n|:-|:-|\n|`who`| Critter whose stat is read|\n|`stat`| `STAT_*` from `define.h`|\n\nReturns the value of a desired attribute/stat in a critter object (who)."
|
|
836
836
|
}
|
|
837
837
|
},
|
|
838
838
|
{
|
|
@@ -862,7 +862,7 @@
|
|
|
862
862
|
"category": "base_functions",
|
|
863
863
|
"documentation": {
|
|
864
864
|
"kind": "markdown",
|
|
865
|
-
"value": "```fallout-ssl-tooltip\
|
|
865
|
+
"value": "```fallout-ssl-tooltip\nint get_pc_stat(int pcStat)\n```\nReturns the value of a desired pc-only stat of the obj_dude. These are found in define.h all starting with 'PCSTAT_'."
|
|
866
866
|
}
|
|
867
867
|
},
|
|
868
868
|
{
|
|
@@ -872,7 +872,7 @@
|
|
|
872
872
|
"category": "base_functions",
|
|
873
873
|
"documentation": {
|
|
874
874
|
"kind": "markdown",
|
|
875
|
-
"value": "```fallout-ssl-tooltip\nint get_poison(ObjectPtr who)\n```\n(Fallout 2 only) Returns the value of a given critters' (who) poison level."
|
|
875
|
+
"value": "```fallout-ssl-tooltip\nint get_poison(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter whose poison level is read|\n\n(Fallout 2 only) Returns the value of a given critters' (who) poison level."
|
|
876
876
|
}
|
|
877
877
|
},
|
|
878
878
|
{
|
|
@@ -882,7 +882,7 @@
|
|
|
882
882
|
"category": "base_functions",
|
|
883
883
|
"documentation": {
|
|
884
884
|
"kind": "markdown",
|
|
885
|
-
"value": "```fallout-ssl-tooltip\nvoid gfade_in(int time)\n```\nDoes a palette fade to black. The time parameter is currently not actually used."
|
|
885
|
+
"value": "```fallout-ssl-tooltip\nvoid gfade_in(int time)\n```\n|||\n|:-|:-|\n|`time`| Not used as a duration, but must be non-zero: 0 is a script error and skips the fade|\n\nDoes a palette fade to black. The time parameter is currently not actually used."
|
|
886
886
|
}
|
|
887
887
|
},
|
|
888
888
|
{
|
|
@@ -892,7 +892,7 @@
|
|
|
892
892
|
"category": "base_functions",
|
|
893
893
|
"documentation": {
|
|
894
894
|
"kind": "markdown",
|
|
895
|
-
"value": "```fallout-ssl-tooltip\nvoid gfade_out(int time)\n```\nDoes a palette fade from black to the game palette. The time parameter is currently not actually used."
|
|
895
|
+
"value": "```fallout-ssl-tooltip\nvoid gfade_out(int time)\n```\n|||\n|:-|:-|\n|`time`| Not used as a duration, but must be non-zero: 0 is a script error and skips the fade|\n\nDoes a palette fade from black to the game palette. The time parameter is currently not actually used."
|
|
896
896
|
}
|
|
897
897
|
},
|
|
898
898
|
{
|
|
@@ -902,7 +902,7 @@
|
|
|
902
902
|
"category": "base_functions",
|
|
903
903
|
"documentation": {
|
|
904
904
|
"kind": "markdown",
|
|
905
|
-
"value": "```fallout-ssl-tooltip\nvoid giQ_Option(int iq_test, int msg_list, int msg_num,
|
|
905
|
+
"value": "```fallout-ssl-tooltip\nvoid giQ_Option(int iq_test, int msg_list, int msg_num, Procedure target, int reaction)\n```\n|||\n|:-|:-|\n|`iq_test`| Minimum Intelligence the player needs for the option to appear|\n|`msg_list`| Message file number to read from|\n|`msg_num`| Line number in that message file|\n|`target`| Procedure jumped to when the option is chosen|\n|`reaction`| `GOOD_REACTION`, `NEUTRAL_REACTION` or `BAD_REACTION` from `define.h`|\n\nSets up an option-choice for a reply block if the player's IQ statistic is equal to or greater than a given value (iq_test), getting the string from the message file (msg_list) and message number (msg_num), which will cause a given reaction (reaction), and if chosen will jump to the given (target) procedure.\nThis is the only function that automatically accounts for Smooth Talker perk."
|
|
906
906
|
}
|
|
907
907
|
},
|
|
908
908
|
{
|
|
@@ -922,7 +922,7 @@
|
|
|
922
922
|
"category": "base_functions",
|
|
923
923
|
"documentation": {
|
|
924
924
|
"kind": "markdown",
|
|
925
|
-
"value": "```fallout-ssl-tooltip\nint global_var(int var_index)\n```\nReturns the value of a global variable # (var_index)."
|
|
925
|
+
"value": "```fallout-ssl-tooltip\nint global_var(int var_index)\n```\n|||\n|:-|:-|\n|`var_index`| Index of the global variable (`GVAR_*`)|\n\nReturns the value of a global variable # (var_index)."
|
|
926
926
|
}
|
|
927
927
|
},
|
|
928
928
|
{
|
|
@@ -942,7 +942,7 @@
|
|
|
942
942
|
"category": "base_functions",
|
|
943
943
|
"documentation": {
|
|
944
944
|
"kind": "markdown",
|
|
945
|
-
"value": "```fallout-ssl-tooltip\nint has_skill(ObjectPtr who, int skill)\n```\nReturns the level of the skill (0-17) of the target critter. (0 to 200 for Fallout 1), (0 to 300 for Fallout 2)"
|
|
945
|
+
"value": "```fallout-ssl-tooltip\nint has_skill(ObjectPtr who, int skill)\n```\n|||\n|:-|:-|\n|`who`| Critter whose skill is read; 0 is returned for a non-critter|\n|`skill`| `SKILL_*` from `define.h`|\n\nReturns the level of the skill (0-17) of the target critter. (0 to 200 for Fallout 1), (0 to 300 for Fallout 2)"
|
|
946
946
|
}
|
|
947
947
|
},
|
|
948
948
|
{
|
|
@@ -952,7 +952,7 @@
|
|
|
952
952
|
"category": "base_functions",
|
|
953
953
|
"documentation": {
|
|
954
954
|
"kind": "markdown",
|
|
955
|
-
"value": "```fallout-ssl-tooltip\nint has_trait(int trait_type, ObjectPtr who, int trait)\n```\nReturns the value of a given critter object's (who) trait of a given trait_type (see define.h). This can be used to determine if the player has a particular Perk, AI Packet, team num, current rotation, or Trait (finesse, bruiser, etc.)."
|
|
955
|
+
"value": "```fallout-ssl-tooltip\nint has_trait(int trait_type, ObjectPtr who, int trait)\n```\n|||\n|:-|:-|\n|`trait_type`| What to query: `TRAIT_PERK`, `TRAIT_OBJECT` or `TRAIT_TRAIT` (`define_pre.h`)|\n|`who`| Critter (or object) queried|\n|`trait`| Depends on `trait_type`: a `PERK_*` (rank returned), an `OBJECT_*` (`OBJECT_AI_PACKET`, `OBJECT_TEAM_NUM`, `OBJECT_CUR_ROT`) or a `TRAIT_*` (character trait, from `define.h`)|\n\nReturns the value of a given critter object's (who) trait of a given trait_type (see define.h). This can be used to determine if the player has a particular Perk, AI Packet, team num, current rotation, or Trait (finesse, bruiser, etc.)."
|
|
956
956
|
}
|
|
957
957
|
},
|
|
958
958
|
{
|
|
@@ -972,7 +972,7 @@
|
|
|
972
972
|
"category": "base_functions",
|
|
973
973
|
"documentation": {
|
|
974
974
|
"kind": "markdown",
|
|
975
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr inven_cmds(ObjectPtr who, int inven_cmd, int slotNum)\n```\nReturns a pointer to the object in the inventory."
|
|
975
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr inven_cmds(ObjectPtr who, int inven_cmd, int slotNum)\n```\n|||\n|:-|:-|\n|`who`| Object whose inventory is read|\n|`inven_cmd`| Command; only `INVEN_CMD_INDEX_PTR` (13) is supported, from `define.h`|\n|`slotNum`| 0-based index into the inventory; out of range returns `NULL`|\n\nReturns a pointer to the object in the inventory."
|
|
976
976
|
}
|
|
977
977
|
},
|
|
978
978
|
{
|
|
@@ -982,7 +982,7 @@
|
|
|
982
982
|
"category": "base_functions",
|
|
983
983
|
"documentation": {
|
|
984
984
|
"kind": "markdown",
|
|
985
|
-
"value": "```fallout-ssl-tooltip\nint inven_count(ObjectPtr what)\n```\nReturns the count of how many inventory slots are filled on a given object (what)."
|
|
985
|
+
"value": "```fallout-ssl-tooltip\nint inven_count(ObjectPtr what)\n```\n|||\n|:-|:-|\n|`what`| Object whose inventory is counted|\n\nReturns the count of how many inventory slots are filled on a given object (what)."
|
|
986
986
|
}
|
|
987
987
|
},
|
|
988
988
|
{
|
|
@@ -992,7 +992,7 @@
|
|
|
992
992
|
"category": "base_functions",
|
|
993
993
|
"documentation": {
|
|
994
994
|
"kind": "markdown",
|
|
995
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr
|
|
995
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr inven_ptr(ObjectPtr what, int slotNum)\n```\n|||\n|:-|:-|\n|`what`| Object whose inventory is read|\n|`slotNum`| 0-based index into the inventory; out of range returns `NULL`|\n\nReturns a pointer to the object in slot # (slotNum) in a given object (what)."
|
|
996
996
|
}
|
|
997
997
|
},
|
|
998
998
|
{
|
|
@@ -1002,7 +1002,7 @@
|
|
|
1002
1002
|
"category": "base_functions",
|
|
1003
1003
|
"documentation": {
|
|
1004
1004
|
"kind": "markdown",
|
|
1005
|
-
"value": "```fallout-ssl-tooltip\nvoid inven_unwield(ObjectPtr who)\n```\nAttempts to cause a critter to unwield any wielded weapons/items. If animations are currently disabled, it will just instantly change the art."
|
|
1005
|
+
"value": "```fallout-ssl-tooltip\nvoid inven_unwield(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter that unwields its items|\n\nAttempts to cause a critter to unwield any wielded weapons/items. If animations are currently disabled, it will just instantly change the art."
|
|
1006
1006
|
}
|
|
1007
1007
|
},
|
|
1008
1008
|
{
|
|
@@ -1012,7 +1012,7 @@
|
|
|
1012
1012
|
"category": "base_functions",
|
|
1013
1013
|
"documentation": {
|
|
1014
1014
|
"kind": "markdown",
|
|
1015
|
-
"value": "```fallout-ssl-tooltip\nbool is_critical(int rollResult)\n```\nReturns `True` if a given contest roll result is a critical result, otherwise `False`."
|
|
1015
|
+
"value": "```fallout-ssl-tooltip\nbool is_critical(int rollResult)\n```\n|||\n|:-|:-|\n|`rollResult`| Result of a contest roll; critical if `ROLL_CRITICAL_SUCCESS` or `ROLL_CRITICAL_FAILURE`|\n\nReturns `True` if a given contest roll result is a critical result, otherwise `False`."
|
|
1016
1016
|
}
|
|
1017
1017
|
},
|
|
1018
1018
|
{
|
|
@@ -1032,7 +1032,7 @@
|
|
|
1032
1032
|
"category": "base_functions",
|
|
1033
1033
|
"documentation": {
|
|
1034
1034
|
"kind": "markdown",
|
|
1035
|
-
"value": "```fallout-ssl-tooltip\nbool is_skill_tagged(int skillNum)\n```\nReturns True if a given skill is tagged."
|
|
1035
|
+
"value": "```fallout-ssl-tooltip\nbool is_skill_tagged(int skillNum)\n```\n|||\n|:-|:-|\n|`skillNum`| `SKILL_*` from `define.h`|\n\nReturns True if a given skill is tagged."
|
|
1036
1036
|
}
|
|
1037
1037
|
},
|
|
1038
1038
|
{
|
|
@@ -1042,7 +1042,7 @@
|
|
|
1042
1042
|
"category": "base_functions",
|
|
1043
1043
|
"documentation": {
|
|
1044
1044
|
"kind": "markdown",
|
|
1045
|
-
"value": "```fallout-ssl-tooltip\nint is_success(int rollResult)\n```\nReturn `True` if a given contest roll result value is a success (including critical success), otherwise `False`."
|
|
1045
|
+
"value": "```fallout-ssl-tooltip\nint is_success(int rollResult)\n```\n|||\n|:-|:-|\n|`rollResult`| Result of a contest roll: `ROLL_*` (`ROLL_SUCCESS` and `ROLL_CRITICAL_SUCCESS` count as success)|\n\nReturn `True` if a given contest roll result value is a success (including critical success), otherwise `False`."
|
|
1046
1046
|
}
|
|
1047
1047
|
},
|
|
1048
1048
|
{
|
|
@@ -1052,7 +1052,7 @@
|
|
|
1052
1052
|
"category": "base_functions",
|
|
1053
1053
|
"documentation": {
|
|
1054
1054
|
"kind": "markdown",
|
|
1055
|
-
"value": "```fallout-ssl-tooltip\nint item_caps_adjust(ObjectPtr obj, int amount)\n```\nModifies the current caps count in an object (obj) by a given amount (amount). Can be positive or negative."
|
|
1055
|
+
"value": "```fallout-ssl-tooltip\nint item_caps_adjust(ObjectPtr obj, int amount)\n```\n|||\n|:-|:-|\n|`obj`| Object whose caps count changes|\n|`amount`| Caps to add; negative removes|\n\nModifies the current caps count in an object (obj) by a given amount (amount). Can be positive or negative."
|
|
1056
1056
|
}
|
|
1057
1057
|
},
|
|
1058
1058
|
{
|
|
@@ -1062,7 +1062,7 @@
|
|
|
1062
1062
|
"category": "base_functions",
|
|
1063
1063
|
"documentation": {
|
|
1064
1064
|
"kind": "markdown",
|
|
1065
|
-
"value": "```fallout-ssl-tooltip\nint item_caps_total(ObjectPtr obj)\n```\nReturns the current caps total in a given object's (obj) inventory."
|
|
1065
|
+
"value": "```fallout-ssl-tooltip\nint item_caps_total(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object whose inventory caps are totaled|\n\nReturns the current caps total in a given object's (obj) inventory."
|
|
1066
1066
|
}
|
|
1067
1067
|
},
|
|
1068
1068
|
{
|
|
@@ -1072,7 +1072,7 @@
|
|
|
1072
1072
|
"category": "base_functions",
|
|
1073
1073
|
"documentation": {
|
|
1074
1074
|
"kind": "markdown",
|
|
1075
|
-
"value": "```fallout-ssl-tooltip\nint jam_lock(ObjectPtr lockableObj)\n```\nJams a lock, which prevents the player from picking the lock for approximately 24 hours. Meant to be used when a player critically fails to pick a lock."
|
|
1075
|
+
"value": "```fallout-ssl-tooltip\nint jam_lock(ObjectPtr lockableObj)\n```\n|||\n|:-|:-|\n|`lockableObj`| Door or container whose lock is jammed|\n\nJams a lock, which prevents the player from picking the lock for approximately 24 hours. Meant to be used when a player critically fails to pick a lock."
|
|
1076
1076
|
}
|
|
1077
1077
|
},
|
|
1078
1078
|
{
|
|
@@ -1082,7 +1082,7 @@
|
|
|
1082
1082
|
"category": "base_functions",
|
|
1083
1083
|
"documentation": {
|
|
1084
1084
|
"kind": "markdown",
|
|
1085
|
-
"value": "```fallout-ssl-tooltip\nvoid kill_critter(ObjectPtr who, int death_frame)\n```\nKills a critter (obj) outright, placing it in the chosen death frame. Note: this does NOT animate the critter, and does NOT refresh the screen! It is meant to be used in scripts run when entering/exiting a map (map_init/map_exit)."
|
|
1085
|
+
"value": "```fallout-ssl-tooltip\nvoid kill_critter(ObjectPtr who, int death_frame)\n```\n|||\n|:-|:-|\n|`who`| Critter to kill|\n|`death_frame`| Death animation, an `ANIM_*` death frame from `animcomd.h` (e.g. `ANIM_fall_back_blood_sf`)|\n\nKills a critter (obj) outright, placing it in the chosen death frame. Note: this does NOT animate the critter, and does NOT refresh the screen! It is meant to be used in scripts run when entering/exiting a map (map_init/map_exit)."
|
|
1086
1086
|
}
|
|
1087
1087
|
},
|
|
1088
1088
|
{
|
|
@@ -1092,7 +1092,7 @@
|
|
|
1092
1092
|
"category": "base_functions",
|
|
1093
1093
|
"documentation": {
|
|
1094
1094
|
"kind": "markdown",
|
|
1095
|
-
"value": "```fallout-ssl-tooltip\nvoid kill_critter_type(int pid)\n```\nKills all critters of a given type (pid) outright. NOTE: This can result in the 'frozen bodies' issue! kill_critter should always be used instead if possible, for this reason. Frozen bodies causes no actual gameplay issues, but it looks unrealistic and ridiculous."
|
|
1095
|
+
"value": "```fallout-ssl-tooltip\nvoid kill_critter_type(int pid)\n```\n|||\n|:-|:-|\n|`pid`| Prototype id of the critter type to kill|\n\nKills all critters of a given type (pid) outright. NOTE: This can result in the 'frozen bodies' issue! kill_critter should always be used instead if possible, for this reason. Frozen bodies causes no actual gameplay issues, but it looks unrealistic and ridiculous."
|
|
1096
1096
|
}
|
|
1097
1097
|
},
|
|
1098
1098
|
{
|
|
@@ -1112,7 +1112,7 @@
|
|
|
1112
1112
|
"category": "base_functions",
|
|
1113
1113
|
"documentation": {
|
|
1114
1114
|
"kind": "markdown",
|
|
1115
|
-
"value": "```fallout-ssl-tooltip\nvoid load_map(string map_name, int start_location)\n```\nLoads a new map (map_name), removing all scripts currently running and passing on the entrance location (start_location) to the new map's map_init script. Can also use the number representing the map in the map list (for example, between 0 to 64 in Fallout 1)"
|
|
1115
|
+
"value": "```fallout-ssl-tooltip\nvoid load_map(string map_name, int start_location)\n```\n|||\n|:-|:-|\n|`map_name`| Map name string, or the map's index number|\n|`start_location`| Entrance location passed to the new map's `map_init`|\n\nLoads a new map (map_name), removing all scripts currently running and passing on the entrance location (start_location) to the new map's map_init script. Can also use the number representing the map in the map list (for example, between 0 to 64 in Fallout 1)"
|
|
1116
1116
|
}
|
|
1117
1117
|
},
|
|
1118
1118
|
{
|
|
@@ -1122,7 +1122,7 @@
|
|
|
1122
1122
|
"category": "base_functions",
|
|
1123
1123
|
"documentation": {
|
|
1124
1124
|
"kind": "markdown",
|
|
1125
|
-
"value": "```fallout-ssl-tooltip\nint local_var(uint var_index)\n```\nReturns the value of a local variable of given index # (var_index). If the user is not allowed local vars up to this number in the list of critters, this can generate errors."
|
|
1125
|
+
"value": "```fallout-ssl-tooltip\nint local_var(uint var_index)\n```\n|||\n|:-|:-|\n|`var_index`| Index of the script's local variable|\n\nReturns the value of a local variable of given index # (var_index). If the user is not allowed local vars up to this number in the list of critters, this can generate errors."
|
|
1126
1126
|
}
|
|
1127
1127
|
},
|
|
1128
1128
|
{
|
|
@@ -1142,7 +1142,7 @@
|
|
|
1142
1142
|
"category": "base_functions",
|
|
1143
1143
|
"documentation": {
|
|
1144
1144
|
"kind": "markdown",
|
|
1145
|
-
"value": "```fallout-ssl-tooltip\nbool map_is_known(int mapIndex)\n```\nReturns True if a given map index is known, False otherwise."
|
|
1145
|
+
"value": "```fallout-ssl-tooltip\nbool map_is_known(int mapIndex)\n```\n|||\n|:-|:-|\n|`mapIndex`| Map index|\n\nReturns True if a given map index is known, False otherwise."
|
|
1146
1146
|
}
|
|
1147
1147
|
},
|
|
1148
1148
|
{
|
|
@@ -1152,7 +1152,7 @@
|
|
|
1152
1152
|
"category": "base_functions",
|
|
1153
1153
|
"documentation": {
|
|
1154
1154
|
"kind": "markdown",
|
|
1155
|
-
"value": "```fallout-ssl-tooltip\nbool map_known(int mapNum)\n```\nReturns True if a given map # (mapNum) is known, False otherwise."
|
|
1155
|
+
"value": "```fallout-ssl-tooltip\nbool map_known(int mapNum)\n```\n|||\n|:-|:-|\n|`mapNum`| Map number|\n\nReturns True if a given map # (mapNum) is known, False otherwise."
|
|
1156
1156
|
}
|
|
1157
1157
|
},
|
|
1158
1158
|
{
|
|
@@ -1162,7 +1162,7 @@
|
|
|
1162
1162
|
"category": "base_functions",
|
|
1163
1163
|
"documentation": {
|
|
1164
1164
|
"kind": "markdown",
|
|
1165
|
-
"value": "```fallout-ssl-tooltip\nint map_var(uint var_index)\n```\nReturns the value of a map-global variable of a given index # (var_index)."
|
|
1165
|
+
"value": "```fallout-ssl-tooltip\nint map_var(uint var_index)\n```\n|||\n|:-|:-|\n|`var_index`| Index of the map variable|\n\nReturns the value of a map-global variable of a given index # (var_index)."
|
|
1166
1166
|
}
|
|
1167
1167
|
},
|
|
1168
1168
|
{
|
|
@@ -1172,7 +1172,7 @@
|
|
|
1172
1172
|
"category": "base_functions",
|
|
1173
1173
|
"documentation": {
|
|
1174
1174
|
"kind": "markdown",
|
|
1175
|
-
"value": "```fallout-ssl-tooltip\nvoid mark_area_known(int areaType, int areaIndex, int known)\n```\nMarks a town area or map location on the world map. The areaType parameter selects whether to mark by area (MARK_TYPE_TOWN) or by map index (MARK_TYPE_MAP). The areaIndex identifies the area or map, and known sets the state (MARK_STATE_KNOWN or MARK_STATE_VISITED)."
|
|
1175
|
+
"value": "```fallout-ssl-tooltip\nvoid mark_area_known(int areaType, int areaIndex, int known)\n```\n|||\n|:-|:-|\n|`areaType`| `MARK_TYPE_TOWN` or `MARK_TYPE_MAP` from `define.h`|\n|`areaIndex`| Town area index (for `MARK_TYPE_TOWN`) or map index (for `MARK_TYPE_MAP`)|\n|`known`| `MARK_STATE_*` from `define.h` (`MARK_STATE_KNOWN`, `MARK_STATE_VISITED`; `MARK_STATE_INVISIBLE` hides a town); ignored for maps|\n\nMarks a town area or map location on the world map. The areaType parameter selects whether to mark by area (MARK_TYPE_TOWN) or by map index (MARK_TYPE_MAP). The areaIndex identifies the area or map, and known sets the state (MARK_STATE_KNOWN or MARK_STATE_VISITED)."
|
|
1176
1176
|
}
|
|
1177
1177
|
},
|
|
1178
1178
|
{
|
|
@@ -1182,7 +1182,7 @@
|
|
|
1182
1182
|
"category": "base_functions",
|
|
1183
1183
|
"documentation": {
|
|
1184
1184
|
"kind": "markdown",
|
|
1185
|
-
"value": "```fallout-ssl-tooltip\
|
|
1185
|
+
"value": "```fallout-ssl-tooltip\nstring message_str(int list, int msg_num)\n```\n|||\n|:-|:-|\n|`list`| Message file (list) number|\n|`msg_num`| Message number within the list; a negative value yields \"Error\"|\n\nReturns a string from the message module for a given list and a given # (msg_num)."
|
|
1186
1186
|
}
|
|
1187
1187
|
},
|
|
1188
1188
|
{
|
|
@@ -1192,7 +1192,7 @@
|
|
|
1192
1192
|
"category": "base_functions",
|
|
1193
1193
|
"documentation": {
|
|
1194
1194
|
"kind": "markdown",
|
|
1195
|
-
"value": "```fallout-ssl-tooltip\nint metarule(int rule, int param)\n```\nGeneral engine query function supporting ~27 different rules. The rule parameter selects the operation (e.g. METARULE_SIGNAL_END_GAME, METARULE_TEST_FIRSTRUN, METARULE_IS_LOADGAME, METARULE_PARTY_COUNT, etc.), and param provides additional data for that rule. Returns an integer result depending on the rule."
|
|
1195
|
+
"value": "```fallout-ssl-tooltip\nint metarule(int rule, int param)\n```\n|||\n|:-|:-|\n|`rule`| `METARULE_*` from `define.h`|\n|`param`| Argument for the chosen `rule`; meaning depends on it|\n\nGeneral engine query function supporting ~27 different rules. The rule parameter selects the operation (e.g. METARULE_SIGNAL_END_GAME, METARULE_TEST_FIRSTRUN, METARULE_IS_LOADGAME, METARULE_PARTY_COUNT, etc.), and param provides additional data for that rule. Returns an integer result depending on the rule."
|
|
1196
1196
|
}
|
|
1197
1197
|
},
|
|
1198
1198
|
{
|
|
@@ -1202,7 +1202,7 @@
|
|
|
1202
1202
|
"category": "base_functions",
|
|
1203
1203
|
"documentation": {
|
|
1204
1204
|
"kind": "markdown",
|
|
1205
|
-
"value": "```fallout-ssl-tooltip\nint metarule3(int rule, int param1, int param2, int param3)\n```\nExtended engine query function supporting ~12 rules that require multiple parameters. Used for operations like clearing timed events (METARULE3_CLR_FIXED_TIMED_EVENTS), querying kill counts (METARULE3_KILL_COUNT), worldmap subtile operations, and critter iteration."
|
|
1205
|
+
"value": "```fallout-ssl-tooltip\nint metarule3(int rule, int param1, int param2, int param3)\n```\n|||\n|:-|:-|\n|`rule`| `METARULE3_*` from `define.h`|\n|`param1`| First argument of the chosen `rule`; meaning depends on it|\n|`param2`| Second argument of the chosen `rule`; meaning depends on it|\n|`param3`| Third argument of the chosen `rule`; meaning depends on it|\n\nExtended engine query function supporting ~12 rules that require multiple parameters. Used for operations like clearing timed events (METARULE3_CLR_FIXED_TIMED_EVENTS), querying kill counts (METARULE3_KILL_COUNT), worldmap subtile operations, and critter iteration."
|
|
1206
1206
|
}
|
|
1207
1207
|
},
|
|
1208
1208
|
{
|
|
@@ -1212,7 +1212,7 @@
|
|
|
1212
1212
|
"category": "base_functions",
|
|
1213
1213
|
"documentation": {
|
|
1214
1214
|
"kind": "markdown",
|
|
1215
|
-
"value": "```fallout-ssl-tooltip\
|
|
1215
|
+
"value": "```fallout-ssl-tooltip\nvoid move_obj_inven_to_obj(ObjectPtr srcObj, ObjectPtr destObj)\n```\nMoves an object's (srcObj) entire inventory into another object's (destObj) inventory."
|
|
1216
1216
|
}
|
|
1217
1217
|
},
|
|
1218
1218
|
{
|
|
@@ -1222,7 +1222,7 @@
|
|
|
1222
1222
|
"category": "base_functions",
|
|
1223
1223
|
"documentation": {
|
|
1224
1224
|
"kind": "markdown",
|
|
1225
|
-
"value": "```fallout-ssl-tooltip\nint move_to(ObjectPtr obj, int tile_num, int elev)\n```\nImmediately moves object `obj` to the given tile number and elevation (0-2) on the current map.\nUsing this to change elevations during loading an in-combat save will lead to a crash. If `move_to` called in `map_enter_p_proc`, wrap in `not_is_loading_game` to avoid the crash."
|
|
1225
|
+
"value": "```fallout-ssl-tooltip\nint move_to(ObjectPtr obj, int tile_num, int elev)\n```\n|||\n|:-|:-|\n|`obj`| Object to move|\n|`tile_num`| Destination tile number|\n|`elev`| Destination elevation, 0-2|\n\nImmediately moves object `obj` to the given tile number and elevation (0-2) on the current map.\nUsing this to change elevations during loading an in-combat save will lead to a crash. If `move_to` called in `map_enter_p_proc`, wrap in `not_is_loading_game` to avoid the crash."
|
|
1226
1226
|
}
|
|
1227
1227
|
},
|
|
1228
1228
|
{
|
|
@@ -1232,7 +1232,7 @@
|
|
|
1232
1232
|
"category": "base_functions",
|
|
1233
1233
|
"documentation": {
|
|
1234
1234
|
"kind": "markdown",
|
|
1235
|
-
"value": "```fallout-ssl-tooltip\nint obj_art_fid(ObjectPtr obj)\n```\nReturns the fid # (used to index art) of a given object (obj)."
|
|
1235
|
+
"value": "```fallout-ssl-tooltip\nint obj_art_fid(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object whose art id is read|\n\nReturns the fid # (used to index art) of a given object (obj)."
|
|
1236
1236
|
}
|
|
1237
1237
|
},
|
|
1238
1238
|
{
|
|
@@ -1252,7 +1252,7 @@
|
|
|
1252
1252
|
"category": "base_functions",
|
|
1253
1253
|
"documentation": {
|
|
1254
1254
|
"kind": "markdown",
|
|
1255
|
-
"value": "```fallout-ssl-tooltip\nbool obj_can_hear_obj(ObjectPtr src_obj, ObjectPtr dst_obj)\n```\nReturns True if the source object (src_obj) is capable of hearing the destination object (dst_obj). This includes distance factors, current activity (standing/walking/running), and skill use (stealth/etc.)."
|
|
1255
|
+
"value": "```fallout-ssl-tooltip\nbool obj_can_hear_obj(ObjectPtr src_obj, ObjectPtr dst_obj)\n```\n|||\n|:-|:-|\n|`src_obj`| Listener|\n|`dst_obj`| Object that may be heard|\n\nReturns True if the source object (src_obj) is capable of hearing the destination object (dst_obj). This includes distance factors, current activity (standing/walking/running), and skill use (stealth/etc.)."
|
|
1256
1256
|
}
|
|
1257
1257
|
},
|
|
1258
1258
|
{
|
|
@@ -1262,7 +1262,7 @@
|
|
|
1262
1262
|
"category": "base_functions",
|
|
1263
1263
|
"documentation": {
|
|
1264
1264
|
"kind": "markdown",
|
|
1265
|
-
"value": "```fallout-ssl-tooltip\nbool obj_can_see_obj(ObjectPtr src_obj, ObjectPtr dst_obj)\n```\nReturns True if the source object (src_obj) has line-of-sight (LOS) with the destination object (dst_obj). This also takes into account perception & stealth rolls of the objects are critters."
|
|
1265
|
+
"value": "```fallout-ssl-tooltip\nbool obj_can_see_obj(ObjectPtr src_obj, ObjectPtr dst_obj)\n```\n|||\n|:-|:-|\n|`src_obj`| Viewer|\n|`dst_obj`| Object that may be seen|\n\nReturns True if the source object (src_obj) has line-of-sight (LOS) with the destination object (dst_obj). This also takes into account perception & stealth rolls of the objects are critters."
|
|
1266
1266
|
}
|
|
1267
1267
|
},
|
|
1268
1268
|
{
|
|
@@ -1272,7 +1272,7 @@
|
|
|
1272
1272
|
"category": "base_functions",
|
|
1273
1273
|
"documentation": {
|
|
1274
1274
|
"kind": "markdown",
|
|
1275
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr obj_carrying_pid_obj(ObjectPtr who, int pid)\n```\nReturns an Object pointer to an instance of an object of type pid if an object (who) is carrying an object of that type."
|
|
1275
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr obj_carrying_pid_obj(ObjectPtr who, int pid)\n```\n|||\n|:-|:-|\n|`who`| Object whose inventory is searched|\n|`pid`| Prototype id to look for|\n\nReturns an Object pointer to an instance of an object of type pid if an object (who) is carrying an object of that type."
|
|
1276
1276
|
}
|
|
1277
1277
|
},
|
|
1278
1278
|
{
|
|
@@ -1282,7 +1282,7 @@
|
|
|
1282
1282
|
"category": "base_functions",
|
|
1283
1283
|
"documentation": {
|
|
1284
1284
|
"kind": "markdown",
|
|
1285
|
-
"value": "```fallout-ssl-tooltip\nvoid obj_close(ObjectPtr what)\n```\nAttempts to close a given object (what) if it is of an openable type."
|
|
1285
|
+
"value": "```fallout-ssl-tooltip\nvoid obj_close(ObjectPtr what)\n```\n|||\n|:-|:-|\n|`what`| Door or container to close|\n\nAttempts to close a given object (what) if it is of an openable type."
|
|
1286
1286
|
}
|
|
1287
1287
|
},
|
|
1288
1288
|
{
|
|
@@ -1292,7 +1292,7 @@
|
|
|
1292
1292
|
"category": "base_functions",
|
|
1293
1293
|
"documentation": {
|
|
1294
1294
|
"kind": "markdown",
|
|
1295
|
-
"value": "```fallout-ssl-tooltip\nvoid obj_drop_everything(ObjectPtr who)\n```\nCauses a critter object (who) to drop all objects in it's inventory and drop it on the ground at its feet."
|
|
1295
|
+
"value": "```fallout-ssl-tooltip\nvoid obj_drop_everything(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter that drops its inventory|\n\nCauses a critter object (who) to drop all objects in it's inventory and drop it on the ground at its feet."
|
|
1296
1296
|
}
|
|
1297
1297
|
},
|
|
1298
1298
|
{
|
|
@@ -1302,7 +1302,7 @@
|
|
|
1302
1302
|
"category": "base_functions",
|
|
1303
1303
|
"documentation": {
|
|
1304
1304
|
"kind": "markdown",
|
|
1305
|
-
"value": "```fallout-ssl-tooltip\nint obj_is_carrying_obj_pid(ObjectPtr obj,
|
|
1305
|
+
"value": "```fallout-ssl-tooltip\nint obj_is_carrying_obj_pid(ObjectPtr obj, int pid)\n```\n|||\n|:-|:-|\n|`obj`| Object whose inventory is searched|\n|`pid`| Prototype id to count|\n\nReturns the quantity of objects with matching prototype index #'s (pid) carried in the inventory of another object (obj)."
|
|
1306
1306
|
}
|
|
1307
1307
|
},
|
|
1308
1308
|
{
|
|
@@ -1312,7 +1312,7 @@
|
|
|
1312
1312
|
"category": "base_functions",
|
|
1313
1313
|
"documentation": {
|
|
1314
1314
|
"kind": "markdown",
|
|
1315
|
-
"value": "```fallout-ssl-tooltip\nbool obj_is_locked(ObjectPtr what)\n```\nReturns True if a given object (what) is a locked object, False if it is unlocked or not a lockable object."
|
|
1315
|
+
"value": "```fallout-ssl-tooltip\nbool obj_is_locked(ObjectPtr what)\n```\n|||\n|:-|:-|\n|`what`| Object tested|\n\nReturns True if a given object (what) is a locked object, False if it is unlocked or not a lockable object."
|
|
1316
1316
|
}
|
|
1317
1317
|
},
|
|
1318
1318
|
{
|
|
@@ -1322,7 +1322,7 @@
|
|
|
1322
1322
|
"category": "base_functions",
|
|
1323
1323
|
"documentation": {
|
|
1324
1324
|
"kind": "markdown",
|
|
1325
|
-
"value": "```fallout-ssl-tooltip\nbool obj_is_open(ObjectPtr what)\n```\nReturns True if a given object (what) is an open object, False if it is closed or not an openable object."
|
|
1325
|
+
"value": "```fallout-ssl-tooltip\nbool obj_is_open(ObjectPtr what)\n```\n|||\n|:-|:-|\n|`what`| Object tested|\n\nReturns True if a given object (what) is an open object, False if it is closed or not an openable object."
|
|
1326
1326
|
}
|
|
1327
1327
|
},
|
|
1328
1328
|
{
|
|
@@ -1332,7 +1332,7 @@
|
|
|
1332
1332
|
"category": "base_functions",
|
|
1333
1333
|
"documentation": {
|
|
1334
1334
|
"kind": "markdown",
|
|
1335
|
-
"value": "```fallout-ssl-tooltip\nbool obj_is_visible_flag(ObjectPtr who)\n```\n(Fallout 2 only) Returns True if a given object (who) is turned on (visible), False otherwise."
|
|
1335
|
+
"value": "```fallout-ssl-tooltip\nbool obj_is_visible_flag(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Object tested|\n\n(Fallout 2 only) Returns True if a given object (who) is turned on (visible), False otherwise."
|
|
1336
1336
|
}
|
|
1337
1337
|
},
|
|
1338
1338
|
{
|
|
@@ -1342,7 +1342,7 @@
|
|
|
1342
1342
|
"category": "base_functions",
|
|
1343
1343
|
"documentation": {
|
|
1344
1344
|
"kind": "markdown",
|
|
1345
|
-
"value": "```fallout-ssl-tooltip\nint obj_item_subtype(ObjectPtr item_obj)\n```\nReturns the subtype of an object of type 'item'. Examples would be food, armor, weapons, etc."
|
|
1345
|
+
"value": "```fallout-ssl-tooltip\nint obj_item_subtype(ObjectPtr item_obj)\n```\n|||\n|:-|:-|\n|`item_obj`| Item whose subtype (`item_type_*` from `define.h`) is read|\n\nReturns the subtype of an object of type 'item'. Examples would be food, armor, weapons, etc."
|
|
1346
1346
|
}
|
|
1347
1347
|
},
|
|
1348
1348
|
{
|
|
@@ -1352,7 +1352,7 @@
|
|
|
1352
1352
|
"category": "base_functions",
|
|
1353
1353
|
"documentation": {
|
|
1354
1354
|
"kind": "markdown",
|
|
1355
|
-
"value": "```fallout-ssl-tooltip\nvoid obj_lock(ObjectPtr what)\n```\nAttempts to lock a given object (what) if it is of a lockable type."
|
|
1355
|
+
"value": "```fallout-ssl-tooltip\nvoid obj_lock(ObjectPtr what)\n```\n|||\n|:-|:-|\n|`what`| Door or container to lock|\n\nAttempts to lock a given object (what) if it is of a lockable type."
|
|
1356
1356
|
}
|
|
1357
1357
|
},
|
|
1358
1358
|
{
|
|
@@ -1362,7 +1362,7 @@
|
|
|
1362
1362
|
"category": "base_functions",
|
|
1363
1363
|
"documentation": {
|
|
1364
1364
|
"kind": "markdown",
|
|
1365
|
-
"value": "```fallout-ssl-tooltip\nstring obj_name(ObjectPtr obj)\n```\nReturns a string representing the name of the given object (what)."
|
|
1365
|
+
"value": "```fallout-ssl-tooltip\nstring obj_name(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object whose name is returned|\n\nReturns a string representing the name of the given object (what)."
|
|
1366
1366
|
}
|
|
1367
1367
|
},
|
|
1368
1368
|
{
|
|
@@ -1372,7 +1372,7 @@
|
|
|
1372
1372
|
"category": "base_functions",
|
|
1373
1373
|
"documentation": {
|
|
1374
1374
|
"kind": "markdown",
|
|
1375
|
-
"value": "```fallout-ssl-tooltip\nbool obj_on_screen(ObjectPtr what)\n```\nReturns True if a given object (what) is currently being drawn on-screen, False if it is not."
|
|
1375
|
+
"value": "```fallout-ssl-tooltip\nbool obj_on_screen(ObjectPtr what)\n```\n|||\n|:-|:-|\n|`what`| Object tested|\n\nReturns True if a given object (what) is currently being drawn on-screen, False if it is not."
|
|
1376
1376
|
}
|
|
1377
1377
|
},
|
|
1378
1378
|
{
|
|
@@ -1382,7 +1382,7 @@
|
|
|
1382
1382
|
"category": "base_functions",
|
|
1383
1383
|
"documentation": {
|
|
1384
1384
|
"kind": "markdown",
|
|
1385
|
-
"value": "```fallout-ssl-tooltip\nvoid obj_open(ObjectPtr what)\n```\nAttempts to open a given object (what) if it is of an openable type."
|
|
1385
|
+
"value": "```fallout-ssl-tooltip\nvoid obj_open(ObjectPtr what)\n```\n|||\n|:-|:-|\n|`what`| Door or container to open|\n\nAttempts to open a given object (what) if it is of an openable type."
|
|
1386
1386
|
}
|
|
1387
1387
|
},
|
|
1388
1388
|
{
|
|
@@ -1392,7 +1392,7 @@
|
|
|
1392
1392
|
"category": "base_functions",
|
|
1393
1393
|
"documentation": {
|
|
1394
1394
|
"kind": "markdown",
|
|
1395
|
-
"value": "```fallout-ssl-tooltip\nint obj_pid(ObjectPtr obj)\n```\nReturns the prototype id # (pid) of an object (obj)."
|
|
1395
|
+
"value": "```fallout-ssl-tooltip\nint obj_pid(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object whose prototype id is read|\n\nReturns the prototype id # (pid) of an object (obj)."
|
|
1396
1396
|
}
|
|
1397
1397
|
},
|
|
1398
1398
|
{
|
|
@@ -1402,7 +1402,7 @@
|
|
|
1402
1402
|
"category": "base_functions",
|
|
1403
1403
|
"documentation": {
|
|
1404
1404
|
"kind": "markdown",
|
|
1405
|
-
"value": "```fallout-ssl-tooltip\nvoid obj_set_light_level(ObjectPtr obj, int intensity, int distance)\n```\nSet the light level for an object to a given intensity (0-100, percentage of possible maximum intensity), and distance of light in hexes (0-8)."
|
|
1405
|
+
"value": "```fallout-ssl-tooltip\nvoid obj_set_light_level(ObjectPtr obj, int intensity, int distance)\n```\n|||\n|:-|:-|\n|`obj`| Object that emits the light|\n|`intensity`| Light intensity, 0-100 (percent of maximum)|\n|`distance`| Light radius in hexes, 0-8|\n\nSet the light level for an object to a given intensity (0-100, percentage of possible maximum intensity), and distance of light in hexes (0-8)."
|
|
1406
1406
|
}
|
|
1407
1407
|
},
|
|
1408
1408
|
{
|
|
@@ -1412,7 +1412,7 @@
|
|
|
1412
1412
|
"category": "base_functions",
|
|
1413
1413
|
"documentation": {
|
|
1414
1414
|
"kind": "markdown",
|
|
1415
|
-
"value": "```fallout-ssl-tooltip\nint obj_type(ObjectPtr obj)\n```\nReturns the type of an object (obj). This would be 'Item', 'Wall', 'Scenery', etc."
|
|
1415
|
+
"value": "```fallout-ssl-tooltip\nint obj_type(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object whose type is read|\n\nReturns the type of an object (obj). This would be 'Item', 'Wall', 'Scenery', etc."
|
|
1416
1416
|
}
|
|
1417
1417
|
},
|
|
1418
1418
|
{
|
|
@@ -1422,7 +1422,7 @@
|
|
|
1422
1422
|
"category": "base_functions",
|
|
1423
1423
|
"documentation": {
|
|
1424
1424
|
"kind": "markdown",
|
|
1425
|
-
"value": "```fallout-ssl-tooltip\nvoid obj_unlock(ObjectPtr what)\n```\nAttempts to unlock a given object (what) if it is of a lockable type."
|
|
1425
|
+
"value": "```fallout-ssl-tooltip\nvoid obj_unlock(ObjectPtr what)\n```\n|||\n|:-|:-|\n|`what`| Door or container to unlock|\n\nAttempts to unlock a given object (what) if it is of a lockable type."
|
|
1426
1426
|
}
|
|
1427
1427
|
},
|
|
1428
1428
|
{
|
|
@@ -1432,7 +1432,7 @@
|
|
|
1432
1432
|
"category": "base_functions",
|
|
1433
1433
|
"documentation": {
|
|
1434
1434
|
"kind": "markdown",
|
|
1435
|
-
"value": "```fallout-ssl-tooltip\nvoid override_map_start(int x, int y, int elev, int rot)\n```\nUsed when loading a new map, this forces the player (obj_dude) to start at a particular location (x/y), elevation (0-2) and rotation (0-5) when first coming up."
|
|
1435
|
+
"value": "```fallout-ssl-tooltip\nvoid override_map_start(int x, int y, int elev, int rot)\n```\n|||\n|:-|:-|\n|`x`| Start hex column; start tile is 200 * y + x|\n|`y`| Start hex row; start tile is 200 * y + x|\n|`elev`| Start elevation, 0-2|\n|`rot`| Start rotation, 0-5|\n\nUsed when loading a new map, this forces the player (obj_dude) to start at a particular location (x/y), elevation (0-2) and rotation (0-5) when first coming up."
|
|
1436
1436
|
}
|
|
1437
1437
|
},
|
|
1438
1438
|
{
|
|
@@ -1442,7 +1442,7 @@
|
|
|
1442
1442
|
"category": "base_functions",
|
|
1443
1443
|
"documentation": {
|
|
1444
1444
|
"kind": "markdown",
|
|
1445
|
-
"value": "```fallout-ssl-tooltip\nvoid party_add(ObjectPtr who)\n```\nAdds a given critter (who) into the list of party members. This will also setup those objects so that they will not be saved in maps, and certain other things."
|
|
1445
|
+
"value": "```fallout-ssl-tooltip\nvoid party_add(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter to add to the party|\n\nAdds a given critter (who) into the list of party members. This will also setup those objects so that they will not be saved in maps, and certain other things."
|
|
1446
1446
|
}
|
|
1447
1447
|
},
|
|
1448
1448
|
{
|
|
@@ -1452,7 +1452,7 @@
|
|
|
1452
1452
|
"category": "base_functions",
|
|
1453
1453
|
"documentation": {
|
|
1454
1454
|
"kind": "markdown",
|
|
1455
|
-
"value": "```fallout-ssl-tooltip\nint party_member_count(bool countHidden)\n```\nReturns the count of the currently in-party party members. (countHidden) determines whether or not to count the hidden members (hangers-on)."
|
|
1455
|
+
"value": "```fallout-ssl-tooltip\nint party_member_count(bool countHidden)\n```\n|||\n|:-|:-|\n|`countHidden`| Also count hidden members (hangers-on)|\n\nReturns the count of the currently in-party party members. (countHidden) determines whether or not to count the hidden members (hangers-on)."
|
|
1456
1456
|
}
|
|
1457
1457
|
},
|
|
1458
1458
|
{
|
|
@@ -1462,7 +1462,7 @@
|
|
|
1462
1462
|
"category": "base_functions",
|
|
1463
1463
|
"documentation": {
|
|
1464
1464
|
"kind": "markdown",
|
|
1465
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr party_member_obj(int pid)\n```\nReturns an ObjectPtr to a party member that matches a given pid. If that critter isn't currently a member of the party, then it will return NULL."
|
|
1465
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr party_member_obj(int pid)\n```\n|||\n|:-|:-|\n|`pid`| Prototype id of the party member|\n\nReturns an ObjectPtr to a party member that matches a given pid. If that critter isn't currently a member of the party, then it will return NULL."
|
|
1466
1466
|
}
|
|
1467
1467
|
},
|
|
1468
1468
|
{
|
|
@@ -1472,7 +1472,7 @@
|
|
|
1472
1472
|
"category": "base_functions",
|
|
1473
1473
|
"documentation": {
|
|
1474
1474
|
"kind": "markdown",
|
|
1475
|
-
"value": "```fallout-ssl-tooltip\nvoid party_remove(ObjectPtr who)\n```\nRemoves a given critter (who) from the list of party members. This will also change those objects so that certain object- and map-level things will respond differently to them."
|
|
1475
|
+
"value": "```fallout-ssl-tooltip\nvoid party_remove(ObjectPtr who)\n```\n|||\n|:-|:-|\n|`who`| Critter to remove from the party|\n\nRemoves a given critter (who) from the list of party members. This will also change those objects so that certain object- and map-level things will respond differently to them."
|
|
1476
1476
|
}
|
|
1477
1477
|
},
|
|
1478
1478
|
{
|
|
@@ -1482,7 +1482,7 @@
|
|
|
1482
1482
|
"category": "base_functions",
|
|
1483
1483
|
"documentation": {
|
|
1484
1484
|
"kind": "markdown",
|
|
1485
|
-
"value": "```fallout-ssl-tooltip\nvoid pickup_obj(ObjectPtr obj)\n```\nCauses the critter self-object to animate and attempt to pick up a given object (obj). If used in regard to a critter, this flag is pinged when a steal detect fails. In other words when detected stealing, pickup_obj is called for the person you were stealing from."
|
|
1485
|
+
"value": "```fallout-ssl-tooltip\nvoid pickup_obj(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object to pick up|\n\nCauses the critter self-object to animate and attempt to pick up a given object (obj). If used in regard to a critter, this flag is pinged when a steal detect fails. In other words when detected stealing, pickup_obj is called for the person you were stealing from."
|
|
1486
1486
|
}
|
|
1487
1487
|
},
|
|
1488
1488
|
{
|
|
@@ -1502,7 +1502,7 @@
|
|
|
1502
1502
|
"category": "base_functions",
|
|
1503
1503
|
"documentation": {
|
|
1504
1504
|
"kind": "markdown",
|
|
1505
|
-
"value": "```fallout-ssl-tooltip\
|
|
1505
|
+
"value": "```fallout-ssl-tooltip\nvoid play_sfx(string sfxFileName)\n```\nStarts a new sound effect to be played on the queue."
|
|
1506
1506
|
}
|
|
1507
1507
|
},
|
|
1508
1508
|
{
|
|
@@ -1512,7 +1512,7 @@
|
|
|
1512
1512
|
"category": "base_functions",
|
|
1513
1513
|
"documentation": {
|
|
1514
1514
|
"kind": "markdown",
|
|
1515
|
-
"value": "```fallout-ssl-tooltip\nvoid poison(ObjectPtr who, int amount)\n```\nModifies the critter's poison level by a given amount, which can be negative"
|
|
1515
|
+
"value": "```fallout-ssl-tooltip\nvoid poison(ObjectPtr who, int amount)\n```\n|||\n|:-|:-|\n|`who`| Critter whose poison level changes|\n|`amount`| Change to the poison level; negative reduces it|\n\nModifies the critter's poison level by a given amount, which can be negative"
|
|
1516
1516
|
}
|
|
1517
1517
|
},
|
|
1518
1518
|
{
|
|
@@ -1522,7 +1522,7 @@
|
|
|
1522
1522
|
"category": "base_functions",
|
|
1523
1523
|
"documentation": {
|
|
1524
1524
|
"kind": "markdown",
|
|
1525
|
-
"value": "```fallout-ssl-tooltip\nint proto_data(int pid, int data_member)\n```\nReturns the value (can be int or string) of a data-member of a given prototype (pid)."
|
|
1525
|
+
"value": "```fallout-ssl-tooltip\nint proto_data(int pid, int data_member)\n```\n|||\n|:-|:-|\n|`pid`| Prototype id to read|\n|`data_member`| Prototype field offset, a `PROTO_*` constant from `define_extra.h`|\n\nReturns the value (can be int or string) of a data-member of a given prototype (pid)."
|
|
1526
1526
|
}
|
|
1527
1527
|
},
|
|
1528
1528
|
{
|
|
@@ -1532,7 +1532,7 @@
|
|
|
1532
1532
|
"category": "base_functions",
|
|
1533
1533
|
"documentation": {
|
|
1534
1534
|
"kind": "markdown",
|
|
1535
|
-
"value": "```fallout-ssl-tooltip\nvoid radiation_dec(ObjectPtr who, int amount)\n```\nDecrements a critter's radiation counter by a given amount. NOTE: This should only be done to the player (obj_dude) in Fallout due to design restrictions!"
|
|
1535
|
+
"value": "```fallout-ssl-tooltip\nvoid radiation_dec(ObjectPtr who, int amount)\n```\n|||\n|:-|:-|\n|`who`| Critter whose radiation counter drops; should only be `dude_obj`|\n|`amount`| Radiation to remove|\n\nDecrements a critter's radiation counter by a given amount. NOTE: This should only be done to the player (obj_dude) in Fallout due to design restrictions!"
|
|
1536
1536
|
}
|
|
1537
1537
|
},
|
|
1538
1538
|
{
|
|
@@ -1542,7 +1542,7 @@
|
|
|
1542
1542
|
"category": "base_functions",
|
|
1543
1543
|
"documentation": {
|
|
1544
1544
|
"kind": "markdown",
|
|
1545
|
-
"value": "```fallout-ssl-tooltip\nvoid radiation_inc(ObjectPtr who, int amount)\n```\nIncrements a critter's radiation counter by a given amount. NOTE: This should only be done to the player (obj_dude) in Fallout due to design restrictions!"
|
|
1545
|
+
"value": "```fallout-ssl-tooltip\nvoid radiation_inc(ObjectPtr who, int amount)\n```\n|||\n|:-|:-|\n|`who`| Critter whose radiation counter rises; should only be `dude_obj`|\n|`amount`| Radiation to add|\n\nIncrements a critter's radiation counter by a given amount. NOTE: This should only be done to the player (obj_dude) in Fallout due to design restrictions!"
|
|
1546
1546
|
}
|
|
1547
1547
|
},
|
|
1548
1548
|
{
|
|
@@ -1552,7 +1552,7 @@
|
|
|
1552
1552
|
"category": "base_functions",
|
|
1553
1553
|
"documentation": {
|
|
1554
1554
|
"kind": "markdown",
|
|
1555
|
-
"value": "```fallout-ssl-tooltip\nint random(int min, int max)\n```\nReturns a random value between (min) and (max), inclusive."
|
|
1555
|
+
"value": "```fallout-ssl-tooltip\nint random(int min, int max)\n```\n|||\n|:-|:-|\n|`min`| Lowest value returned (inclusive)|\n|`max`| Highest value returned (inclusive)|\n\nReturns a random value between (min) and (max), inclusive."
|
|
1556
1556
|
}
|
|
1557
1557
|
},
|
|
1558
1558
|
{
|
|
@@ -1572,7 +1572,7 @@
|
|
|
1572
1572
|
"category": "base_functions",
|
|
1573
1573
|
"documentation": {
|
|
1574
1574
|
"kind": "markdown",
|
|
1575
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_animate(ObjectPtr what, int anim, int delay)\n```\nAdds a single, in-place animation on an object (what) to an animation sequence-list, at a given delay from the previous animation (delay should always be -1)!"
|
|
1575
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_animate(ObjectPtr what, int anim, int delay)\n```\n|||\n|:-|:-|\n|`what`| Object to animate|\n|`anim`| Animation, an `ANIM_*` constant from `animcomd.h`|\n|`delay`| Delay from the previous animation in the sequence; should always be -1|\n\nAdds a single, in-place animation on an object (what) to an animation sequence-list, at a given delay from the previous animation (delay should always be -1)!"
|
|
1576
1576
|
}
|
|
1577
1577
|
},
|
|
1578
1578
|
{
|
|
@@ -1582,7 +1582,7 @@
|
|
|
1582
1582
|
"category": "base_functions",
|
|
1583
1583
|
"documentation": {
|
|
1584
1584
|
"kind": "markdown",
|
|
1585
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_animate_forever(ObjectPtr what, int anim, int delay)\n```\nAdds a single, in-place animation on an object (what) to an animation sequence-list, at a given delay from the previous animation (delay should always be -1)! This animation will animate continuously until something in the system interrupts it. To be used *very* sparingly, for instance Gizmo's sign and the 'pray' signs in the children of the cathedral (which will have to be toned down)."
|
|
1585
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_animate_forever(ObjectPtr what, int anim, int delay)\n```\n|||\n|:-|:-|\n|`what`| Object to animate|\n|`anim`| Animation, an `ANIM_*` constant from `animcomd.h`|\n|`delay`| Delay from the previous animation in the sequence; should always be -1|\n\nAdds a single, in-place animation on an object (what) to an animation sequence-list, at a given delay from the previous animation (delay should always be -1)! This animation will animate continuously until something in the system interrupts it. To be used *very* sparingly, for instance Gizmo's sign and the 'pray' signs in the children of the cathedral (which will have to be toned down)."
|
|
1586
1586
|
}
|
|
1587
1587
|
},
|
|
1588
1588
|
{
|
|
@@ -1592,7 +1592,7 @@
|
|
|
1592
1592
|
"category": "base_functions",
|
|
1593
1593
|
"documentation": {
|
|
1594
1594
|
"kind": "markdown",
|
|
1595
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_animate_reverse(ObjectPtr what, int anim, int delay)\n```\nAdds a single, in-place reversed animation on an object (what) to an animation sequence-list, at a given delay from the previous animation (delay should always be -1)! reg_anim_begin void Anim Tells the system to start an animation sequence-list."
|
|
1595
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_animate_reverse(ObjectPtr what, int anim, int delay)\n```\n|||\n|:-|:-|\n|`what`| Object animated in place|\n|`anim`| `ANIM_*` from `animcomd.h`|\n|`delay`| Delay from the previous animation; always pass -1|\n\nAdds a single, in-place reversed animation on an object (what) to an animation sequence-list, at a given delay from the previous animation (delay should always be -1)! reg_anim_begin void Anim Tells the system to start an animation sequence-list."
|
|
1596
1596
|
}
|
|
1597
1597
|
},
|
|
1598
1598
|
{
|
|
@@ -1612,7 +1612,7 @@
|
|
|
1612
1612
|
"category": "base_functions",
|
|
1613
1613
|
"documentation": {
|
|
1614
1614
|
"kind": "markdown",
|
|
1615
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_clear(ObjectPtr object)\n```\nTerminates all animations that are currently registered for a given object."
|
|
1615
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_clear(ObjectPtr object)\n```\n|||\n|:-|:-|\n|`object`| Object whose registered animations are terminated|\n\nTerminates all animations that are currently registered for a given object."
|
|
1616
1616
|
}
|
|
1617
1617
|
},
|
|
1618
1618
|
{
|
|
@@ -1632,7 +1632,7 @@
|
|
|
1632
1632
|
"category": "base_functions",
|
|
1633
1633
|
"documentation": {
|
|
1634
1634
|
"kind": "markdown",
|
|
1635
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_func(int par1, int par2)\n```\nWorks with a list of animations."
|
|
1635
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_func(int par1, int par2)\n```\n|||\n|:-|:-|\n|`par1`| Sub-command: begin a sequence, clear an object's animations, or end the sequence|\n|`par2`| Sub-command argument: the sequence options for begin, the object for clear|\n\nWorks with a list of animations."
|
|
1636
1636
|
}
|
|
1637
1637
|
},
|
|
1638
1638
|
{
|
|
@@ -1642,7 +1642,7 @@
|
|
|
1642
1642
|
"category": "base_functions",
|
|
1643
1643
|
"documentation": {
|
|
1644
1644
|
"kind": "markdown",
|
|
1645
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_obj_move_to_obj(ObjectPtr who, ObjectPtr dest_obj, int delay)\n```\nAdds an animation to cause a critter object (who) to attempt to walk to another object (dest_obj) at a given delay from the previous animation (delay should always be -1)!"
|
|
1645
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_obj_move_to_obj(ObjectPtr who, ObjectPtr dest_obj, int delay)\n```\n|||\n|:-|:-|\n|`who`| Critter that walks|\n|`dest_obj`| Object to walk to|\n|`delay`| Delay from the previous animation; always pass -1|\n\nAdds an animation to cause a critter object (who) to attempt to walk to another object (dest_obj) at a given delay from the previous animation (delay should always be -1)!"
|
|
1646
1646
|
}
|
|
1647
1647
|
},
|
|
1648
1648
|
{
|
|
@@ -1652,7 +1652,7 @@
|
|
|
1652
1652
|
"category": "base_functions",
|
|
1653
1653
|
"documentation": {
|
|
1654
1654
|
"kind": "markdown",
|
|
1655
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_obj_move_to_tile(ObjectPtr who, int dest_tile, int delay)\n```\nAdds an animation to cause a critter object (who) to attempt to walk to a given destination tile number (dest_tile) at a given delay from the previous animation (delay should always be -1)!"
|
|
1655
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_obj_move_to_tile(ObjectPtr who, int dest_tile, int delay)\n```\n|||\n|:-|:-|\n|`who`| Critter that walks|\n|`dest_tile`| Destination tile number|\n|`delay`| Delay from the previous animation; always pass -1|\n\nAdds an animation to cause a critter object (who) to attempt to walk to a given destination tile number (dest_tile) at a given delay from the previous animation (delay should always be -1)!"
|
|
1656
1656
|
}
|
|
1657
1657
|
},
|
|
1658
1658
|
{
|
|
@@ -1662,7 +1662,7 @@
|
|
|
1662
1662
|
"category": "base_functions",
|
|
1663
1663
|
"documentation": {
|
|
1664
1664
|
"kind": "markdown",
|
|
1665
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_obj_run_to_obj(ObjectPtr who, ObjectPtr dest_obj, int delay)\n```\nAdds an animation to cause a critter object (who) to attempt to run to another object (dest_obj) at a given delay from the previous animation (delay should always be -1)!"
|
|
1665
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_obj_run_to_obj(ObjectPtr who, ObjectPtr dest_obj, int delay)\n```\n|||\n|:-|:-|\n|`who`| Critter that runs|\n|`dest_obj`| Object to run to|\n|`delay`| Delay from the previous animation; always pass -1|\n\nAdds an animation to cause a critter object (who) to attempt to run to another object (dest_obj) at a given delay from the previous animation (delay should always be -1)!"
|
|
1666
1666
|
}
|
|
1667
1667
|
},
|
|
1668
1668
|
{
|
|
@@ -1672,7 +1672,7 @@
|
|
|
1672
1672
|
"category": "base_functions",
|
|
1673
1673
|
"documentation": {
|
|
1674
1674
|
"kind": "markdown",
|
|
1675
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_obj_run_to_tile(ObjectPtr who, int dest_tile, int delay)\n```\nAdds an animation to cause a critter object (who) to attempt to run to a given destination tile number (dest_tile) at a given delay from the previous animation (delay should always be -1)!"
|
|
1675
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_obj_run_to_tile(ObjectPtr who, int dest_tile, int delay)\n```\n|||\n|:-|:-|\n|`who`| Critter that runs|\n|`dest_tile`| Destination tile number|\n|`delay`| Delay from the previous animation; always pass -1|\n\nAdds an animation to cause a critter object (who) to attempt to run to a given destination tile number (dest_tile) at a given delay from the previous animation (delay should always be -1)!"
|
|
1676
1676
|
}
|
|
1677
1677
|
},
|
|
1678
1678
|
{
|
|
@@ -1682,7 +1682,7 @@
|
|
|
1682
1682
|
"category": "base_functions",
|
|
1683
1683
|
"documentation": {
|
|
1684
1684
|
"kind": "markdown",
|
|
1685
|
-
"value": "```fallout-ssl-tooltip\nvoid reg_anim_play_sfx(ObjectPtr who, string sfx_name, int delay)\n```\nAdds an animation to cause an object (who) to attempt to play a given sound effect (sfx_name) at a given delay from the previous animation."
|
|
1685
|
+
"value": "```fallout-ssl-tooltip\nvoid reg_anim_play_sfx(ObjectPtr who, string sfx_name, int delay)\n```\n|||\n|:-|:-|\n|`who`| Object that plays the sound|\n|`sfx_name`| Name of the sound effect to play|\n|`delay`| Delay from the previous animation|\n\nAdds an animation to cause an object (who) to attempt to play a given sound effect (sfx_name) at a given delay from the previous animation."
|
|
1686
1686
|
}
|
|
1687
1687
|
},
|
|
1688
1688
|
{
|
|
@@ -1692,7 +1692,7 @@
|
|
|
1692
1692
|
"category": "base_functions",
|
|
1693
1693
|
"documentation": {
|
|
1694
1694
|
"kind": "markdown",
|
|
1695
|
-
"value": "```fallout-ssl-tooltip\nvoid rm_fixed_timer_event(ObjectPtr who, int fixed_val)\n```\nRemoves (clears) all timer events hooked to a given object's (obj) script that have a given fixed_value (fixed_val)."
|
|
1695
|
+
"value": "```fallout-ssl-tooltip\nvoid rm_fixed_timer_event(ObjectPtr who, int fixed_val)\n```\n|||\n|:-|:-|\n|`who`| Object whose script's timer events are searched|\n|`fixed_val`| Only timer events added with this fixed value are removed|\n\nRemoves (clears) all timer events hooked to a given object's (obj) script that have a given fixed_value (fixed_val)."
|
|
1696
1696
|
}
|
|
1697
1697
|
},
|
|
1698
1698
|
{
|
|
@@ -1702,7 +1702,7 @@
|
|
|
1702
1702
|
"category": "base_functions",
|
|
1703
1703
|
"documentation": {
|
|
1704
1704
|
"kind": "markdown",
|
|
1705
|
-
"value": "```fallout-ssl-tooltip\nint rm_mult_objs_from_inven(ObjectPtr who, ObjectPtr obj, int count)\n```\nRemoves (count) instances of an object (obj) from another object's (who's) inventory. Note: this leaves the removed object in at location (0,1) on the map! You must call move_to(...) to place it back on the map. NOTE: This function returns the actual count that was removed (if you attempted to remove more instances than existed). You *MUST* store this value in a variable (though you don't have to actually do anything with it)."
|
|
1705
|
+
"value": "```fallout-ssl-tooltip\nint rm_mult_objs_from_inven(ObjectPtr who, ObjectPtr obj, int count)\n```\n|||\n|:-|:-|\n|`who`| Object whose inventory is changed|\n|`obj`| Object to remove|\n|`count`| Number of instances to remove; the function returns how many were actually removed|\n\nRemoves (count) instances of an object (obj) from another object's (who's) inventory. Note: this leaves the removed object in at location (0,1) on the map! You must call move_to(...) to place it back on the map. NOTE: This function returns the actual count that was removed (if you attempted to remove more instances than existed). You *MUST* store this value in a variable (though you don't have to actually do anything with it)."
|
|
1706
1706
|
}
|
|
1707
1707
|
},
|
|
1708
1708
|
{
|
|
@@ -1712,7 +1712,7 @@
|
|
|
1712
1712
|
"category": "base_functions",
|
|
1713
1713
|
"documentation": {
|
|
1714
1714
|
"kind": "markdown",
|
|
1715
|
-
"value": "```fallout-ssl-tooltip\nvoid rm_obj_from_inven(ObjectPtr who, ObjectPtr obj)\n```\nRemoves an object (obj) from another object's (who's) inventory. NOTE: this leaves the removed object in at location (0,1) on the map! You must call move_to(...) to place it back on the map."
|
|
1715
|
+
"value": "```fallout-ssl-tooltip\nvoid rm_obj_from_inven(ObjectPtr who, ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`who`| Object whose inventory is changed|\n|`obj`| Object to remove|\n\nRemoves an object (obj) from another object's (who's) inventory. NOTE: this leaves the removed object in at location (0,1) on the map! You must call move_to(...) to place it back on the map."
|
|
1716
1716
|
}
|
|
1717
1717
|
},
|
|
1718
1718
|
{
|
|
@@ -1722,17 +1722,7 @@
|
|
|
1722
1722
|
"category": "base_functions",
|
|
1723
1723
|
"documentation": {
|
|
1724
1724
|
"kind": "markdown",
|
|
1725
|
-
"value": "```fallout-ssl-tooltip\nvoid rm_timer_event(ObjectPtr obj)\n```\nRemoves (clears) all timer events hooked to a given object's (obj) script."
|
|
1726
|
-
}
|
|
1727
|
-
},
|
|
1728
|
-
{
|
|
1729
|
-
"label": "roll_dice",
|
|
1730
|
-
"kind": 3,
|
|
1731
|
-
"source": "builtin",
|
|
1732
|
-
"category": "base_functions",
|
|
1733
|
-
"documentation": {
|
|
1734
|
-
"kind": "markdown",
|
|
1735
|
-
"value": "```fallout-ssl-tooltip\nCritter roll_dice(obj Critter, int skill)\n```\nReturns the value of the completed dice roll. NOTE: Avellone says this is unimplemented."
|
|
1725
|
+
"value": "```fallout-ssl-tooltip\nvoid rm_timer_event(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object whose script's timer events are removed|\n\nRemoves (clears) all timer events hooked to a given object's (obj) script."
|
|
1736
1726
|
}
|
|
1737
1727
|
},
|
|
1738
1728
|
{
|
|
@@ -1742,7 +1732,7 @@
|
|
|
1742
1732
|
"category": "base_functions",
|
|
1743
1733
|
"documentation": {
|
|
1744
1734
|
"kind": "markdown",
|
|
1745
|
-
"value": "```fallout-ssl-tooltip\nint roll_vs_skill(ObjectPtr who, int skill, int modifier)\n```\nReturns the value of a completed skill roll made upon an object's (who's) skill level with a given skill, and modified by a given amount (may be zero). This value may then be passed to is_success and is_critical to determine the appropriate states, and the how_much call can be used to determine the difference succeeded or failed by."
|
|
1735
|
+
"value": "```fallout-ssl-tooltip\nint roll_vs_skill(ObjectPtr who, int skill, int modifier)\n```\n|||\n|:-|:-|\n|`who`| Object whose skill level is rolled against|\n|`skill`| `SKILL_*` from `define.h`|\n|`modifier`| Amount added to the skill value before rolling; may be zero|\n\nReturns the value of a completed skill roll made upon an object's (who's) skill level with a given skill, and modified by a given amount (may be zero). This value may then be passed to is_success and is_critical to determine the appropriate states, and the how_much call can be used to determine the difference succeeded or failed by."
|
|
1746
1736
|
}
|
|
1747
1737
|
},
|
|
1748
1738
|
{
|
|
@@ -1752,7 +1742,7 @@
|
|
|
1752
1742
|
"category": "base_functions",
|
|
1753
1743
|
"documentation": {
|
|
1754
1744
|
"kind": "markdown",
|
|
1755
|
-
"value": "```fallout-ssl-tooltip\nint rotation_to_tile(int srcTile, int destTile)\n```\nReturns the rotation (0...5) to face a particular tile (destTile) from a particular tile (srcTile)."
|
|
1745
|
+
"value": "```fallout-ssl-tooltip\nint rotation_to_tile(int srcTile, int destTile)\n```\n|||\n|:-|:-|\n|`srcTile`| Tile to face from|\n|`destTile`| Tile to face|\n\nReturns the rotation (0...5) to face a particular tile (destTile) from a particular tile (srcTile)."
|
|
1756
1746
|
}
|
|
1757
1747
|
},
|
|
1758
1748
|
{
|
|
@@ -1812,7 +1802,7 @@
|
|
|
1812
1802
|
"category": "base_functions",
|
|
1813
1803
|
"documentation": {
|
|
1814
1804
|
"kind": "markdown",
|
|
1815
|
-
"value": "```fallout-ssl-tooltip\nint set_critter_stat(ObjectPtr who, int stat, int mod)\n```\nDOES NOT SET THE STAT.\n\n**Modifies** attribute `stat` in critter `who` by value `mod`."
|
|
1805
|
+
"value": "```fallout-ssl-tooltip\nint set_critter_stat(ObjectPtr who, int stat, int mod)\n```\n|||\n|:-|:-|\n|`who`| Must be `dude_obj`; any other critter is rejected and the call returns -1|\n|`stat`| `STAT_*` from `define.h`|\n|`mod`| Amount added to the current stat value, not the new value|\n\nDOES NOT SET THE STAT.\n\n**Modifies** attribute `stat` in critter `who` by value `mod`."
|
|
1816
1806
|
}
|
|
1817
1807
|
},
|
|
1818
1808
|
{
|
|
@@ -1822,7 +1812,7 @@
|
|
|
1822
1812
|
"category": "base_functions",
|
|
1823
1813
|
"documentation": {
|
|
1824
1814
|
"kind": "markdown",
|
|
1825
|
-
"value": "```fallout-ssl-tooltip\nvoid set_exit_grids(
|
|
1815
|
+
"value": "```fallout-ssl-tooltip\nvoid set_exit_grids(int markElev, int mapID, int elevation, int tileNum, int rotation)\n```\n|||\n|:-|:-|\n|`markElev`| Elevation whose exit grids are changed|\n|`mapID`| Destination map; -1 stays on this map|\n|`elevation`| Destination elevation|\n|`tileNum`| Destination tile number|\n\nSets all exit grids on a given elevation (markElev) to point to a destination mapID (may be -1 which means stay on this map), elevation, tileNum, and rotation."
|
|
1826
1816
|
}
|
|
1827
1817
|
},
|
|
1828
1818
|
{
|
|
@@ -1842,7 +1832,7 @@
|
|
|
1842
1832
|
"category": "base_functions",
|
|
1843
1833
|
"documentation": {
|
|
1844
1834
|
"kind": "markdown",
|
|
1845
|
-
"value": "```fallout-ssl-tooltip\nvoid set_light_level(int level)
|
|
1835
|
+
"value": "```fallout-ssl-tooltip\nvoid set_light_level(int level)\n```\n|||\n|:-|:-|\n|`level`| Ambient light from Full Darkness to Full Daylight; not a linear percentage, and some levels cannot be set|\n\nSets the ambient light level (1-100). The range is Full Darkness to Full Daylight. NOTE: level is NOT percentange, full darkness is not black screen. set_light_level(0) actually corresponds to 25% brightness, and as level increases, brightness makes 2 huge jumps in the middle (49-51). Thus, certain brightness levels simply cannot be set."
|
|
1846
1836
|
}
|
|
1847
1837
|
},
|
|
1848
1838
|
{
|
|
@@ -1862,7 +1852,7 @@
|
|
|
1862
1852
|
"category": "base_functions",
|
|
1863
1853
|
"documentation": {
|
|
1864
1854
|
"kind": "markdown",
|
|
1865
|
-
"value": "```fallout-ssl-tooltip\nvoid set_map_music(int mapID, string sound_path)
|
|
1855
|
+
"value": "```fallout-ssl-tooltip\nvoid set_map_music(int mapID, string sound_path)\n```\nSets the map background music to the sound file at path."
|
|
1866
1856
|
}
|
|
1867
1857
|
},
|
|
1868
1858
|
{
|
|
@@ -1872,7 +1862,7 @@
|
|
|
1872
1862
|
"category": "base_functions",
|
|
1873
1863
|
"documentation": {
|
|
1874
1864
|
"kind": "markdown",
|
|
1875
|
-
"value": "```fallout-ssl-tooltip\nvoid set_map_start(int x, int y, int elev, int rot)\n```\nSets the start location & rotation (0-5) for the next time this map is entered (loaded & run)."
|
|
1865
|
+
"value": "```fallout-ssl-tooltip\nvoid set_map_start(int x, int y, int elev, int rot)\n```\n|||\n|:-|:-|\n|`x`| Tile column of the start position (0-199)|\n|`y`| Tile row of the start position (0-199)|\n|`elev`| Start elevation|\n|`rot`| Start rotation, 0-5|\n\nSets the start location & rotation (0-5) for the next time this map is entered (loaded & run)."
|
|
1876
1866
|
}
|
|
1877
1867
|
},
|
|
1878
1868
|
{
|
|
@@ -1892,7 +1882,7 @@
|
|
|
1892
1882
|
"category": "base_functions",
|
|
1893
1883
|
"documentation": {
|
|
1894
1884
|
"kind": "markdown",
|
|
1895
|
-
"value": "```fallout-ssl-tooltip\nvoid set_obj_visibility(ObjectPtr obj, bool visibility)\n```\nSets the `OBJ_OFF` flag for an object (makes it not drawn).\nNotes:\n - Visibility arg is _inverted_: `set_obj_visibility(who, true)` makes object invisible.\n - Does not work when loading game."
|
|
1885
|
+
"value": "```fallout-ssl-tooltip\nvoid set_obj_visibility(ObjectPtr obj, bool visibility)\n```\n|||\n|:-|:-|\n|`visibility`| Inverted: `true` makes the object invisible, `false` shows it|\n\nSets the `OBJ_OFF` flag for an object (makes it not drawn).\nNotes:\n - Visibility arg is _inverted_: `set_obj_visibility(who, true)` makes object invisible.\n - Does not work when loading game."
|
|
1896
1886
|
}
|
|
1897
1887
|
},
|
|
1898
1888
|
{
|
|
@@ -2002,7 +1992,7 @@
|
|
|
2002
1992
|
"category": "base_functions",
|
|
2003
1993
|
"documentation": {
|
|
2004
1994
|
"kind": "markdown",
|
|
2005
|
-
"value": "```fallout-ssl-tooltip\nvoid start_gdialog(int msgFileNum, ObjectPtr who, int mood, int headNum, int backgroundIdx)\n```\nStart the dialogue system focusing on a critter `who` and in a given `mood`.\nThis call sets up the appropriate dialog windows, head art, etc.\nIf this call is not made before the normal dialog calls (`sayReply`, `sayMessage`, `sayOption`, etc.) then the dialog windows will not come up, and only grey boxes will appear with the text.\n\n`mood` argument is unused in vanilla. Instead, the function checks LVAR 0 of the script:\n- `LVAR > 10` - good reaction (happy head).\n- `-10 > LVAR >= 10` - neutral.\n- Else, angry head.\n\nIf sfall is installed, and `StartGDialogFix` is enabled, argument `mood` does work:\n- If `mood == -1`, use vanilla behaviour (check LVAR 0).\n- Else, use argument value. Same thresholds apply."
|
|
1995
|
+
"value": "```fallout-ssl-tooltip\nvoid start_gdialog(int msgFileNum, ObjectPtr who, int mood, int headNum, int backgroundIdx)\n```\n|||\n|:-|:-|\n|`msgFileNum`| Message file number; ignored by the engine|\n|`who`| Critter the dialog focuses on|\n|`mood`| Reaction level; unused in vanilla (LVAR 0 decides). With sfall `StartGDialogFix`, -1 keeps the LVAR 0 behaviour|\n|`headNum`| `HEAD_*` from `define.h`; -1 is commonly passed|\n|`backgroundIdx`| `BACKGROUND*` from `define.h`; -1 is commonly passed|\n\nStart the dialogue system focusing on a critter `who` and in a given `mood`.\nThis call sets up the appropriate dialog windows, head art, etc.\nIf this call is not made before the normal dialog calls (`sayReply`, `sayMessage`, `sayOption`, etc.) then the dialog windows will not come up, and only grey boxes will appear with the text.\n\n`mood` argument is unused in vanilla. Instead, the function checks LVAR 0 of the script:\n- `LVAR > 10` - good reaction (happy head).\n- `-10 > LVAR >= 10` - neutral.\n- Else, angry head.\n\nIf sfall is installed, and `StartGDialogFix` is enabled, argument `mood` does work:\n- If `mood == -1`, use vanilla behaviour (check LVAR 0).\n- Else, use argument value. Same thresholds apply."
|
|
2006
1996
|
}
|
|
2007
1997
|
},
|
|
2008
1998
|
{
|
|
@@ -2032,7 +2022,7 @@
|
|
|
2032
2022
|
"category": "base_functions",
|
|
2033
2023
|
"documentation": {
|
|
2034
2024
|
"kind": "markdown",
|
|
2035
|
-
"value": "```fallout-ssl-tooltip\nbool tile_contains_obj_pid(int tile, int elev, int pid)\n```\nReturns True if a particular tile contains an object with a matching prototype index # (obj pid)."
|
|
2025
|
+
"value": "```fallout-ssl-tooltip\nbool tile_contains_obj_pid(int tile, int elev, int pid)\n```\n|||\n|:-|:-|\n|`tile`| Tile number to search|\n|`elev`| Elevation of the tile|\n|`pid`| Prototype index of the object to look for|\n\nReturns True if a particular tile contains an object with a matching prototype index # (obj pid)."
|
|
2036
2026
|
}
|
|
2037
2027
|
},
|
|
2038
2028
|
{
|
|
@@ -2042,7 +2032,7 @@
|
|
|
2042
2032
|
"category": "base_functions",
|
|
2043
2033
|
"documentation": {
|
|
2044
2034
|
"kind": "markdown",
|
|
2045
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr tile_contains_pid_obj(int tile, int elev, int pid)\n```\nReturns a pointer to the first object that matches a particular pid # that is on a particular tile and elevation."
|
|
2035
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr tile_contains_pid_obj(int tile, int elev, int pid)\n```\n|||\n|:-|:-|\n|`tile`| Tile number to search|\n|`elev`| Elevation of the tile|\n|`pid`| Prototype index of the object to look for|\n\nReturns a pointer to the first object that matches a particular pid # that is on a particular tile and elevation."
|
|
2046
2036
|
}
|
|
2047
2037
|
},
|
|
2048
2038
|
{
|
|
@@ -2072,7 +2062,7 @@
|
|
|
2072
2062
|
"category": "base_functions",
|
|
2073
2063
|
"documentation": {
|
|
2074
2064
|
"kind": "markdown",
|
|
2075
|
-
"value": "```fallout-ssl-tooltip\nint tile_in_tile_rect(int tile1, int tile2, int tile3, int tile4, int tile5)\n```\nTests whether a tile falls within a rectangular region defined by the coordinate parameters. Returns 1 if the tile is inside the rectangle, 0 otherwise."
|
|
2065
|
+
"value": "```fallout-ssl-tooltip\nint tile_in_tile_rect(int tile1, int tile2, int tile3, int tile4, int tile5)\n```\n|||\n|:-|:-|\n|`tile1`| One corner of the rectangle: its column is the right edge and its row the top edge|\n|`tile4`| Opposite corner: its column is the left edge and its row the bottom edge|\n|`tile5`| Tile tested for being inside the rectangle|\n\nTests whether a tile falls within a rectangular region defined by the coordinate parameters. Returns 1 if the tile is inside the rectangle, 0 otherwise."
|
|
2076
2066
|
}
|
|
2077
2067
|
},
|
|
2078
2068
|
{
|
|
@@ -2102,7 +2092,7 @@
|
|
|
2102
2092
|
"category": "base_functions",
|
|
2103
2093
|
"documentation": {
|
|
2104
2094
|
"kind": "markdown",
|
|
2105
|
-
"value": "```fallout-ssl-tooltip\nint tile_num_in_direction(int start_tile, int direction, int distance)\n```\nReturns the tile number of a tile offset from a starting tile in a given direction (0-5, the next tile in that direction)."
|
|
2095
|
+
"value": "```fallout-ssl-tooltip\nint tile_num_in_direction(int start_tile, int direction, int distance)\n```\n|||\n|:-|:-|\n|`direction`| Direction, 0-5|\n|`distance`| Number of tiles to offset in that direction|\n\nReturns the tile number of a tile offset from a starting tile in a given direction (0-5, the next tile in that direction)."
|
|
2106
2096
|
}
|
|
2107
2097
|
},
|
|
2108
2098
|
{
|
|
@@ -2112,7 +2102,7 @@
|
|
|
2112
2102
|
"category": "base_functions",
|
|
2113
2103
|
"documentation": {
|
|
2114
2104
|
"kind": "markdown",
|
|
2115
|
-
"value": "```fallout-ssl-tooltip\
|
|
2105
|
+
"value": "```fallout-ssl-tooltip\nstring tokenize(string str, string prevToken, int delimiter)\n```\n|||\n|:-|:-|\n|`prevToken`| `0` on the first call; on later calls the token the previous call returned|\n|`delimiter`| Delimiter character, as a character code|\n\nReturns the token after `prevToken` in a string split on the delimiter character, or `0` when there are no more tokens. The previous token is found by searching the string for its text, so if that text also occurs earlier (a repeated token, or part of an earlier one), the walk continues from the earlier match."
|
|
2116
2106
|
}
|
|
2117
2107
|
},
|
|
2118
2108
|
{
|
|
@@ -2122,7 +2112,7 @@
|
|
|
2122
2112
|
"category": "base_functions",
|
|
2123
2113
|
"documentation": {
|
|
2124
2114
|
"kind": "markdown",
|
|
2125
|
-
"value": "```fallout-ssl-tooltip\nbool town_known(int townArea)\n```\nReturns True if a given town area (townArea) is known, False otherwise."
|
|
2115
|
+
"value": "```fallout-ssl-tooltip\nbool town_known(int townArea)\n```\n|||\n|:-|:-|\n|`townArea`| `AREA_*` from `maps.h`|\n\nReturns True if a given town area (townArea) is known, False otherwise."
|
|
2126
2116
|
}
|
|
2127
2117
|
},
|
|
2128
2118
|
{
|
|
@@ -2152,7 +2142,7 @@
|
|
|
2152
2142
|
"category": "base_functions",
|
|
2153
2143
|
"documentation": {
|
|
2154
2144
|
"kind": "markdown",
|
|
2155
|
-
"value": "```fallout-ssl-tooltip\nObjectPtr use_obj_on_obj(ObjectPtr item, ObjectPtr targetObj)\n```\nAttempt to use an item object on a target object (targetObj). This could be used to have a critter use a Stimpack on the player, for instance, or to use a key on a door."
|
|
2145
|
+
"value": "```fallout-ssl-tooltip\nObjectPtr use_obj_on_obj(ObjectPtr item, ObjectPtr targetObj)\n```\n|||\n|:-|:-|\n|`item`| Item object to use|\n|`targetObj`| Object the item is used on|\n\nAttempt to use an item object on a target object (targetObj). This could be used to have a critter use a Stimpack on the player, for instance, or to use a key on a door."
|
|
2156
2146
|
}
|
|
2157
2147
|
},
|
|
2158
2148
|
{
|
|
@@ -2162,7 +2152,7 @@
|
|
|
2162
2152
|
"category": "base_functions",
|
|
2163
2153
|
"documentation": {
|
|
2164
2154
|
"kind": "markdown",
|
|
2165
|
-
"value": "```fallout-ssl-tooltip\nbool using_skill(ObjectPtr who, int skill)\n```\nReturns True if an active skill is being used, False otherwise. Examples of active skills are Stealth and First Aid."
|
|
2155
|
+
"value": "```fallout-ssl-tooltip\nbool using_skill(ObjectPtr who, int skill)\n```\n|||\n|:-|:-|\n|`skill`| `SKILL_*` from `define.h`|\n\nReturns True if an active skill is being used, False otherwise. Examples of active skills are Stealth and First Aid."
|
|
2166
2156
|
}
|
|
2167
2157
|
},
|
|
2168
2158
|
{
|
|
@@ -2182,7 +2172,7 @@
|
|
|
2182
2172
|
"category": "base_functions",
|
|
2183
2173
|
"documentation": {
|
|
2184
2174
|
"kind": "markdown",
|
|
2185
|
-
"value": "```fallout-ssl-tooltip\nvoid wield_obj(ObjectPtr obj)\n```\nSets up an animation causing a critter (self_obj) to wield an object (obj) in that critters' inventory. This puts that object in the critter's hand."
|
|
2175
|
+
"value": "```fallout-ssl-tooltip\nvoid wield_obj(ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`obj`| Object in the critter's inventory to put in its hand|\n\nSets up an animation causing a critter (self_obj) to wield an object (obj) in that critters' inventory. This puts that object in the critter's hand."
|
|
2186
2176
|
}
|
|
2187
2177
|
},
|
|
2188
2178
|
{
|
|
@@ -2192,7 +2182,7 @@
|
|
|
2192
2182
|
"category": "base_functions",
|
|
2193
2183
|
"documentation": {
|
|
2194
2184
|
"kind": "markdown",
|
|
2195
|
-
"value": "```fallout-ssl-tooltip\nvoid wield_obj_critter(ObjectPtr who, ObjectPtr obj)\n```\nSets up an animation causing a critter (who) to wield an object (obj) in that critters' inventory. This puts that object in the critter's hand."
|
|
2185
|
+
"value": "```fallout-ssl-tooltip\nvoid wield_obj_critter(ObjectPtr who, ObjectPtr obj)\n```\n|||\n|:-|:-|\n|`who`| Critter that wields the object|\n|`obj`| Object in the critter's inventory to put in its hand|\n\nSets up an animation causing a critter (who) to wield an object (obj) in that critters' inventory. This puts that object in the critter's hand."
|
|
2196
2186
|
}
|
|
2197
2187
|
},
|
|
2198
2188
|
{
|
|
@@ -2202,7 +2192,7 @@
|
|
|
2202
2192
|
"category": "base_functions",
|
|
2203
2193
|
"documentation": {
|
|
2204
2194
|
"kind": "markdown",
|
|
2205
|
-
"value": "```fallout-ssl-tooltip\nvoid wm_area_set_pos(int areaIdx, int xPos, int yPos)\n```\nSets the World Map coordinates for a given area/town (areaIdx) to a given x and y position."
|
|
2195
|
+
"value": "```fallout-ssl-tooltip\nvoid wm_area_set_pos(int areaIdx, int xPos, int yPos)\n```\n|||\n|:-|:-|\n|`areaIdx`| `AREA_*` from `maps.h`|\n\nSets the World Map coordinates for a given area/town (areaIdx) to a given x and y position."
|
|
2206
2196
|
}
|
|
2207
2197
|
},
|
|
2208
2198
|
{
|
|
@@ -2982,7 +2972,7 @@
|
|
|
2982
2972
|
"category": "key_functions",
|
|
2983
2973
|
"documentation": {
|
|
2984
2974
|
"kind": "markdown",
|
|
2985
|
-
"value": "```fallout-ssl-tooltip\nvoid AddKey(int key, Procedure proc)\n```\nRegisters a keyboard handler procedure for a given key. When the key is pressed, the associated procedure is called."
|
|
2975
|
+
"value": "```fallout-ssl-tooltip\nvoid AddKey(int key, Procedure proc)\n```\n|||\n|:-|:-|\n|`key`| Key to handle; -1 registers a handler for every key|\n|`proc`| Procedure called when the key is pressed|\n\nRegisters a keyboard handler procedure for a given key. When the key is pressed, the associated procedure is called."
|
|
2986
2976
|
}
|
|
2987
2977
|
},
|
|
2988
2978
|
{
|
|
@@ -3064,7 +3054,7 @@
|
|
|
3064
3054
|
"category": "movie_functions",
|
|
3065
3055
|
"documentation": {
|
|
3066
3056
|
"kind": "markdown",
|
|
3067
|
-
"value": "```fallout-ssl-tooltip\nvoid PlayMovieRect(string filename, int x, int y, int width, int height)\n```\nPlays a movie file within a specified rectangular area on screen."
|
|
3057
|
+
"value": "```fallout-ssl-tooltip\nvoid PlayMovieRect(string filename, int x, int y, int width, int height)\n```\n|||\n|:-|:-|\n|`filename`| Movie file name; `.mve` is appended when it has no extension|\n\nPlays a movie file within a specified rectangular area on screen."
|
|
3068
3058
|
}
|
|
3069
3059
|
},
|
|
3070
3060
|
{
|
|
@@ -3176,7 +3166,7 @@
|
|
|
3176
3166
|
"category": "say_functions",
|
|
3177
3167
|
"documentation": {
|
|
3178
3168
|
"kind": "markdown",
|
|
3179
|
-
"value": "```fallout-ssl-tooltip\nvoid SayMessageTimeout(int timeout)\n```\nSets the display duration in milliseconds for dialog messages shown with SayMessage."
|
|
3169
|
+
"value": "```fallout-ssl-tooltip\nvoid SayMessageTimeout(int timeout)\n```\n|||\n|:-|:-|\n|`timeout`| Display duration in milliseconds|\n\nSets the display duration in milliseconds for dialog messages shown with SayMessage."
|
|
3180
3170
|
}
|
|
3181
3171
|
},
|
|
3182
3172
|
{
|
|
@@ -3186,7 +3176,7 @@
|
|
|
3186
3176
|
"category": "say_functions",
|
|
3187
3177
|
"documentation": {
|
|
3188
3178
|
"kind": "markdown",
|
|
3189
|
-
"value": "```fallout-ssl-tooltip\nvoid SayOption(string text, string proc)\n```\nAdds a selectable dialog option with the given text and callback procedure name."
|
|
3179
|
+
"value": "```fallout-ssl-tooltip\nvoid SayOption(string text, string proc)\n```\n|||\n|:-|:-|\n|`proc`| Name of the procedure called when the option is chosen|\n\nAdds a selectable dialog option with the given text and callback procedure name."
|
|
3190
3180
|
}
|
|
3191
3181
|
},
|
|
3192
3182
|
{
|
|
@@ -3216,7 +3206,7 @@
|
|
|
3216
3206
|
"category": "say_functions",
|
|
3217
3207
|
"documentation": {
|
|
3218
3208
|
"kind": "markdown",
|
|
3219
|
-
"value": "```fallout-ssl-tooltip\nvoid SayOptionWindow(int x, int y, int width, int height, string filename)\n```\nConfigures the display window for dialog options with position, size, and background image."
|
|
3209
|
+
"value": "```fallout-ssl-tooltip\nvoid SayOptionWindow(int x, int y, int width, int height, string filename)\n```\n|||\n|:-|:-|\n|`x`| X position of the options window|\n|`y`| Y position of the options window|\n|`width`| Width of the options window|\n|`height`| Height of the options window|\n|`filename`| Background image file, or 0 for none|\n\nConfigures the display window for dialog options with position, size, and background image."
|
|
3220
3210
|
}
|
|
3221
3211
|
},
|
|
3222
3212
|
{
|
|
@@ -3276,7 +3266,7 @@
|
|
|
3276
3266
|
"category": "say_functions",
|
|
3277
3267
|
"documentation": {
|
|
3278
3268
|
"kind": "markdown",
|
|
3279
|
-
"value": "```fallout-ssl-tooltip\nvoid SayReplyWindow(int x, int y, int width, int height, string filename)\n```\nConfigures the display window for dialog replies with position, size, and background image."
|
|
3269
|
+
"value": "```fallout-ssl-tooltip\nvoid SayReplyWindow(int x, int y, int width, int height, string filename)\n```\n|||\n|:-|:-|\n|`x`| X position of the reply window|\n|`y`| Y position of the reply window|\n|`width`| Width of the reply window|\n|`height`| Height of the reply window|\n|`filename`| Background image file, or 0 for none|\n\nConfigures the display window for dialog replies with position, size, and background image."
|
|
3280
3270
|
}
|
|
3281
3271
|
},
|
|
3282
3272
|
{
|
|
@@ -3296,7 +3286,7 @@
|
|
|
3296
3286
|
"category": "say_functions",
|
|
3297
3287
|
"documentation": {
|
|
3298
3288
|
"kind": "markdown",
|
|
3299
|
-
"value": "```fallout-ssl-tooltip\nvoid SayScrollDown(int x, int y, string normal, string hover, string pressed, string disabled)\n```\nConfigures the scroll-down button for the dialog window with position and graphics for each button state."
|
|
3289
|
+
"value": "```fallout-ssl-tooltip\nvoid SayScrollDown(int x, int y, string normal, string hover, string pressed, string disabled)\n```\n|||\n|:-|:-|\n|`x`| X position of the scroll-down button|\n|`y`| Y position of the scroll-down button|\n\nConfigures the scroll-down button for the dialog window with position and graphics for each button state."
|
|
3300
3290
|
}
|
|
3301
3291
|
},
|
|
3302
3292
|
{
|
|
@@ -3306,7 +3296,7 @@
|
|
|
3306
3296
|
"category": "say_functions",
|
|
3307
3297
|
"documentation": {
|
|
3308
3298
|
"kind": "markdown",
|
|
3309
|
-
"value": "```fallout-ssl-tooltip\nvoid SayScrollUp(int x, int y, string normal, string hover, string pressed, string disabled)\n```\nConfigures the scroll-up button for the dialog window with position and graphics for each button state."
|
|
3299
|
+
"value": "```fallout-ssl-tooltip\nvoid SayScrollUp(int x, int y, string normal, string hover, string pressed, string disabled)\n```\n|||\n|:-|:-|\n|`x`| X position of the scroll-up button|\n|`y`| Y position of the scroll-up button|\n\nConfigures the scroll-up button for the dialog window with position and graphics for each button state."
|
|
3310
3300
|
}
|
|
3311
3301
|
},
|
|
3312
3302
|
{
|
|
@@ -3316,7 +3306,7 @@
|
|
|
3316
3306
|
"category": "say_functions",
|
|
3317
3307
|
"documentation": {
|
|
3318
3308
|
"kind": "markdown",
|
|
3319
|
-
"value": "```fallout-ssl-tooltip\nvoid SaySetSpacing(int spacing)\n```\nSets the vertical line spacing in pixels between dialog entries."
|
|
3309
|
+
"value": "```fallout-ssl-tooltip\nvoid SaySetSpacing(int spacing)\n```\n|||\n|:-|:-|\n|`spacing`| Vertical spacing between dialog entries, in pixels|\n\nSets the vertical line spacing in pixels between dialog entries."
|
|
3320
3310
|
}
|
|
3321
3311
|
},
|
|
3322
3312
|
{
|
|
@@ -7499,16 +7489,6 @@
|
|
|
7499
7489
|
"value": "```fallout-ssl-tooltip\nvoid write_string(int address, string value)\n```\nThese functions take a memory address as the parameter and can write to arbitrary pieces of Fallout's address _None of these functions will work unless_ `AllowUnsafeScripting` _is enabled in_ `ddraw.ini`."
|
|
7500
7490
|
}
|
|
7501
7491
|
},
|
|
7502
|
-
{
|
|
7503
|
-
"label": "SetOneOptPause",
|
|
7504
|
-
"kind": 3,
|
|
7505
|
-
"source": "builtin",
|
|
7506
|
-
"category": "sound_functions",
|
|
7507
|
-
"documentation": {
|
|
7508
|
-
"kind": "markdown",
|
|
7509
|
-
"value": "```fallout-ssl-tooltip\nvoid SetOneOptPause(int flag)\n```\nToggles the pause-on-focus-loss behavior for media playback. When flag is non-zero, media pauses when the game loses focus."
|
|
7510
|
-
}
|
|
7511
|
-
},
|
|
7512
7492
|
{
|
|
7513
7493
|
"label": "SoundDelete",
|
|
7514
7494
|
"kind": 3,
|
|
@@ -7516,7 +7496,7 @@
|
|
|
7516
7496
|
"category": "sound_functions",
|
|
7517
7497
|
"documentation": {
|
|
7518
7498
|
"kind": "markdown",
|
|
7519
|
-
"value": "```fallout-ssl-tooltip\nvoid SoundDelete(int handle)\n```\nFrees and releases a sound resource identified by the given handle."
|
|
7499
|
+
"value": "```fallout-ssl-tooltip\nvoid SoundDelete(int handle)\n```\n|||\n|:-|:-|\n|`handle`| Handle returned by `SoundPlay`|\n\nFrees and releases a sound resource identified by the given handle."
|
|
7520
7500
|
}
|
|
7521
7501
|
},
|
|
7522
7502
|
{
|
|
@@ -7526,7 +7506,7 @@
|
|
|
7526
7506
|
"category": "sound_functions",
|
|
7527
7507
|
"documentation": {
|
|
7528
7508
|
"kind": "markdown",
|
|
7529
|
-
"value": "```fallout-ssl-tooltip\nvoid SoundPause(int handle)\n```\nPauses playback of the sound identified by the given handle."
|
|
7509
|
+
"value": "```fallout-ssl-tooltip\nvoid SoundPause(int handle)\n```\n|||\n|:-|:-|\n|`handle`| Handle returned by `SoundPlay`|\n\nPauses playback of the sound identified by the given handle."
|
|
7530
7510
|
}
|
|
7531
7511
|
},
|
|
7532
7512
|
{
|
|
@@ -7536,7 +7516,7 @@
|
|
|
7536
7516
|
"category": "sound_functions",
|
|
7537
7517
|
"documentation": {
|
|
7538
7518
|
"kind": "markdown",
|
|
7539
|
-
"value": "```fallout-ssl-tooltip\nint SoundPlay(string filename, int flags)\n```\nPlays a sound file with the specified flags and returns a handle that can be used with SoundPause, SoundResume, SoundStop, SoundRewind, and SoundDelete."
|
|
7519
|
+
"value": "```fallout-ssl-tooltip\nint SoundPlay(string filename, int flags)\n```\n|||\n|:-|:-|\n|`flags`| Bit flags: `0x01` loop (otherwise fire-and-forget), `0x02` 16-bit samples (otherwise 8-bit), `0x100` load into memory, `0x200` stream|\n\nPlays a sound file with the specified flags and returns a handle that can be used with SoundPause, SoundResume, SoundStop, SoundRewind, and SoundDelete."
|
|
7540
7520
|
}
|
|
7541
7521
|
},
|
|
7542
7522
|
{
|
|
@@ -7546,7 +7526,7 @@
|
|
|
7546
7526
|
"category": "sound_functions",
|
|
7547
7527
|
"documentation": {
|
|
7548
7528
|
"kind": "markdown",
|
|
7549
|
-
"value": "```fallout-ssl-tooltip\nvoid SoundResume(int handle)\n```\nResumes playback of a previously paused sound identified by the given handle."
|
|
7529
|
+
"value": "```fallout-ssl-tooltip\nvoid SoundResume(int handle)\n```\n|||\n|:-|:-|\n|`handle`| Handle returned by `SoundPlay`|\n\nResumes playback of a previously paused sound identified by the given handle."
|
|
7550
7530
|
}
|
|
7551
7531
|
},
|
|
7552
7532
|
{
|
|
@@ -7556,7 +7536,7 @@
|
|
|
7556
7536
|
"category": "sound_functions",
|
|
7557
7537
|
"documentation": {
|
|
7558
7538
|
"kind": "markdown",
|
|
7559
|
-
"value": "```fallout-ssl-tooltip\nvoid SoundRewind(int handle)\n```\nRewinds the sound identified by the given handle back to the beginning."
|
|
7539
|
+
"value": "```fallout-ssl-tooltip\nvoid SoundRewind(int handle)\n```\n|||\n|:-|:-|\n|`handle`| Handle returned by `SoundPlay`|\n\nRewinds the sound identified by the given handle back to the beginning."
|
|
7560
7540
|
}
|
|
7561
7541
|
},
|
|
7562
7542
|
{
|
|
@@ -7566,7 +7546,7 @@
|
|
|
7566
7546
|
"category": "sound_functions",
|
|
7567
7547
|
"documentation": {
|
|
7568
7548
|
"kind": "markdown",
|
|
7569
|
-
"value": "```fallout-ssl-tooltip\nvoid SoundStop(int handle)\n```\nStops playback of the sound identified by the given handle."
|
|
7549
|
+
"value": "```fallout-ssl-tooltip\nvoid SoundStop(int handle)\n```\n|||\n|:-|:-|\n|`handle`| Handle returned by `SoundPlay`|\n\nStops playback of the sound identified by the given handle."
|
|
7570
7550
|
}
|
|
7571
7551
|
},
|
|
7572
7552
|
{
|
|
@@ -7576,7 +7556,7 @@
|
|
|
7576
7556
|
"category": "window_functions",
|
|
7577
7557
|
"documentation": {
|
|
7578
7558
|
"kind": "markdown",
|
|
7579
|
-
"value": "```fallout-ssl-tooltip\nvoid ActivateRegion(string name, int
|
|
7559
|
+
"value": "```fallout-ssl-tooltip\nvoid ActivateRegion(string name, int event)\n```\n|||\n|:-|:-|\n|`event`| Mouse event to simulate: `0` press, `1` release, `2` enter, `3` exit (the procedures set with `AddRegionProc`); `5` right press, `6` right release|\n\nRuns a named region's procedure as if the given mouse event happened on it."
|
|
7580
7560
|
}
|
|
7581
7561
|
},
|
|
7582
7562
|
{
|
|
@@ -7586,7 +7566,7 @@
|
|
|
7586
7566
|
"category": "window_functions",
|
|
7587
7567
|
"documentation": {
|
|
7588
7568
|
"kind": "markdown",
|
|
7589
|
-
"value": "```fallout-ssl-tooltip\nvoid AddButton(string name, int x, int y, int width, int height)\n```\nCreates a button with the given name at the specified position and size in the currently selected window."
|
|
7569
|
+
"value": "```fallout-ssl-tooltip\nvoid AddButton(string name, int x, int y, int width, int height)\n```\n|||\n|:-|:-|\n|`name`| Name for the new button; used by the other `AddButton*` functions and `DeleteButton`|\n|`x`| X position in the currently selected window|\n|`y`| Y position in the currently selected window|\n|`width`| Width|\n|`height`| Height|\n\nCreates a button with the given name at the specified position and size in the currently selected window."
|
|
7590
7570
|
}
|
|
7591
7571
|
},
|
|
7592
7572
|
{
|
|
@@ -7596,7 +7576,7 @@
|
|
|
7596
7576
|
"category": "window_functions",
|
|
7597
7577
|
"documentation": {
|
|
7598
7578
|
"kind": "markdown",
|
|
7599
|
-
"value": "```fallout-ssl-tooltip\nvoid AddButtonFlag(string name, int flag)\n```\nSets a flag attribute on the named button."
|
|
7579
|
+
"value": "```fallout-ssl-tooltip\nvoid AddButtonFlag(string name, int flag)\n```\n|||\n|:-|:-|\n|`name`| Name of a button created with `AddButton`|\n\nSets a flag attribute on the named button."
|
|
7600
7580
|
}
|
|
7601
7581
|
},
|
|
7602
7582
|
{
|
|
@@ -7606,7 +7586,7 @@
|
|
|
7606
7586
|
"category": "window_functions",
|
|
7607
7587
|
"documentation": {
|
|
7608
7588
|
"kind": "markdown",
|
|
7609
|
-
"value": "```fallout-ssl-tooltip\nvoid AddButtonGFX(string name, string
|
|
7589
|
+
"value": "```fallout-ssl-tooltip\nvoid AddButtonGFX(string name, string pressed, string normal, string hover)\n```\n|||\n|:-|:-|\n|`name`| Name of a button created with `AddButton`|\n\nSets the graphics for button states: pressed, normal, and hover appearances."
|
|
7610
7590
|
}
|
|
7611
7591
|
},
|
|
7612
7592
|
{
|
|
@@ -7616,7 +7596,7 @@
|
|
|
7616
7596
|
"category": "window_functions",
|
|
7617
7597
|
"documentation": {
|
|
7618
7598
|
"kind": "markdown",
|
|
7619
|
-
"value": "```fallout-ssl-tooltip\nvoid AddButtonProc(string name, Procedure
|
|
7599
|
+
"value": "```fallout-ssl-tooltip\nvoid AddButtonProc(string name, Procedure enter, Procedure exit, Procedure press, Procedure release)\n```\n|||\n|:-|:-|\n|`name`| Name of a button created with `AddButton`|\n\nAssigns callback procedures to a button for mouse enter, mouse exit, button press and button release."
|
|
7620
7600
|
}
|
|
7621
7601
|
},
|
|
7622
7602
|
{
|
|
@@ -7626,7 +7606,7 @@
|
|
|
7626
7606
|
"category": "window_functions",
|
|
7627
7607
|
"documentation": {
|
|
7628
7608
|
"kind": "markdown",
|
|
7629
|
-
"value": "```fallout-ssl-tooltip\nvoid AddButtonRightProc(string name, Procedure press, Procedure release)\n```\nAssigns right-click callback procedures to a button for press and release events."
|
|
7609
|
+
"value": "```fallout-ssl-tooltip\nvoid AddButtonRightProc(string name, Procedure press, Procedure release)\n```\n|||\n|:-|:-|\n|`name`| Name of a button created with `AddButton`|\n\nAssigns right-click callback procedures to a button for press and release events."
|
|
7630
7610
|
}
|
|
7631
7611
|
},
|
|
7632
7612
|
{
|
|
@@ -7636,7 +7616,7 @@
|
|
|
7636
7616
|
"category": "window_functions",
|
|
7637
7617
|
"documentation": {
|
|
7638
7618
|
"kind": "markdown",
|
|
7639
|
-
"value": "```fallout-ssl-tooltip\nvoid AddButtonText(string name, string text)\n```\nSets the text label displayed on the named button."
|
|
7619
|
+
"value": "```fallout-ssl-tooltip\nvoid AddButtonText(string name, string text)\n```\n|||\n|:-|:-|\n|`name`| Name of a button created with `AddButton`|\n|`text`| Label shown on the button|\n\nSets the text label displayed on the named button."
|
|
7640
7620
|
}
|
|
7641
7621
|
},
|
|
7642
7622
|
{
|
|
@@ -7666,7 +7646,7 @@
|
|
|
7666
7646
|
"category": "window_functions",
|
|
7667
7647
|
"documentation": {
|
|
7668
7648
|
"kind": "markdown",
|
|
7669
|
-
"value": "```fallout-ssl-tooltip\nvoid AddRegionProc(string name, Procedure enter, Procedure exit, Procedure
|
|
7649
|
+
"value": "```fallout-ssl-tooltip\nvoid AddRegionProc(string name, Procedure enter, Procedure exit, Procedure press, Procedure release)\n```\nAssigns callback procedures to a region for mouse enter, mouse exit, button press and button release."
|
|
7670
7650
|
}
|
|
7671
7651
|
},
|
|
7672
7652
|
{
|
|
@@ -7686,7 +7666,7 @@
|
|
|
7686
7666
|
"category": "window_functions",
|
|
7687
7667
|
"documentation": {
|
|
7688
7668
|
"kind": "markdown",
|
|
7689
|
-
"value": "```fallout-ssl-tooltip\nint CheckRegion(string name)\n```\nReturns whether a named region exists in the current window."
|
|
7669
|
+
"value": "```fallout-ssl-tooltip\nint CheckRegion(string name)\n```\n|||\n|:-|:-|\n|`name`| Name of a region in the current window|\n\nReturns whether a named region exists in the current window."
|
|
7690
7670
|
}
|
|
7691
7671
|
},
|
|
7692
7672
|
{
|
|
@@ -7696,7 +7676,7 @@
|
|
|
7696
7676
|
"category": "window_functions",
|
|
7697
7677
|
"documentation": {
|
|
7698
7678
|
"kind": "markdown",
|
|
7699
|
-
"value": "```fallout-ssl-tooltip\nvoid CreateWin(string name, int x, int y, int width, int height)\n```\nCreates a new window with the given name at the specified position and size. Coordinates are scaled to the current screen resolution."
|
|
7679
|
+
"value": "```fallout-ssl-tooltip\nvoid CreateWin(string name, int x, int y, int width, int height)\n```\n|||\n|:-|:-|\n|`name`| Name for the new window; pass it to `SelectWin` and `DeleteWin`|\n|`x`| X position; scaled to the current screen resolution|\n|`y`| Y position; scaled to the current screen resolution|\n|`width`| Width; scaled to the current screen resolution|\n|`height`| Height; scaled to the current screen resolution|\n\nCreates a new window with the given name at the specified position and size. Coordinates are scaled to the current screen resolution."
|
|
7700
7680
|
}
|
|
7701
7681
|
},
|
|
7702
7682
|
{
|
|
@@ -7706,7 +7686,7 @@
|
|
|
7706
7686
|
"category": "window_functions",
|
|
7707
7687
|
"documentation": {
|
|
7708
7688
|
"kind": "markdown",
|
|
7709
|
-
"value": "```fallout-ssl-tooltip\nvoid DeleteButton(string name)\n```\nRemoves the named button from the current window."
|
|
7689
|
+
"value": "```fallout-ssl-tooltip\nvoid DeleteButton(string name)\n```\n|||\n|:-|:-|\n|`name`| Name of a button created with `AddButton`|\n\nRemoves the named button from the current window."
|
|
7710
7690
|
}
|
|
7711
7691
|
},
|
|
7712
7692
|
{
|
|
@@ -7716,7 +7696,7 @@
|
|
|
7716
7696
|
"category": "window_functions",
|
|
7717
7697
|
"documentation": {
|
|
7718
7698
|
"kind": "markdown",
|
|
7719
|
-
"value": "```fallout-ssl-tooltip\nvoid DeleteRegion(string name)\n```\nRemoves the named region from the current window."
|
|
7699
|
+
"value": "```fallout-ssl-tooltip\nvoid DeleteRegion(string name)\n```\n|||\n|:-|:-|\n|`name`| Name of a region in the current window|\n\nRemoves the named region from the current window."
|
|
7720
7700
|
}
|
|
7721
7701
|
},
|
|
7722
7702
|
{
|
|
@@ -7726,7 +7706,7 @@
|
|
|
7726
7706
|
"category": "window_functions",
|
|
7727
7707
|
"documentation": {
|
|
7728
7708
|
"kind": "markdown",
|
|
7729
|
-
"value": "```fallout-ssl-tooltip\nvoid DeleteWin(string name)\n```\nDeletes the named window and frees its resources."
|
|
7709
|
+
"value": "```fallout-ssl-tooltip\nvoid DeleteWin(string name)\n```\n|||\n|:-|:-|\n|`name`| Name of a window created with `CreateWin`|\n\nDeletes the named window and frees its resources."
|
|
7730
7710
|
}
|
|
7731
7711
|
},
|
|
7732
7712
|
{
|
|
@@ -7736,7 +7716,7 @@
|
|
|
7736
7716
|
"category": "window_functions",
|
|
7737
7717
|
"documentation": {
|
|
7738
7718
|
"kind": "markdown",
|
|
7739
|
-
"value": "```fallout-ssl-tooltip\nvoid DisplayGFX(string filename, int x, int y, int width, int height)\n```\nDisplays an image file at the specified position and size within the current window."
|
|
7719
|
+
"value": "```fallout-ssl-tooltip\nvoid DisplayGFX(string filename, int x, int y, int width, int height)\n```\n|||\n|:-|:-|\n|`x`| X position in the current window|\n|`y`| Y position in the current window|\n|`width`| Width the image is drawn at|\n|`height`| Height the image is drawn at|\n\nDisplays an image file at the specified position and size within the current window."
|
|
7740
7720
|
}
|
|
7741
7721
|
},
|
|
7742
7722
|
{
|
|
@@ -7776,7 +7756,7 @@
|
|
|
7776
7756
|
"category": "window_functions",
|
|
7777
7757
|
"documentation": {
|
|
7778
7758
|
"kind": "markdown",
|
|
7779
|
-
"value": "```fallout-ssl-tooltip\nvoid FillRect(int x, int y, int width, int height, int r, int g, int b)\n```\nFills a rectangle at the specified position and size with the given RGB color in the current window."
|
|
7759
|
+
"value": "```fallout-ssl-tooltip\nvoid FillRect(int x, int y, int width, int height, int r, int g, int b)\n```\n|||\n|:-|:-|\n|`x`| X position in the current window|\n|`y`| Y position in the current window|\n|`width`| Width|\n|`height`| Height|\n\nFills a rectangle at the specified position and size with the given RGB color in the current window."
|
|
7780
7760
|
}
|
|
7781
7761
|
},
|
|
7782
7762
|
{
|
|
@@ -7806,7 +7786,7 @@
|
|
|
7806
7786
|
"category": "window_functions",
|
|
7807
7787
|
"documentation": {
|
|
7808
7788
|
"kind": "markdown",
|
|
7809
|
-
"value": "```fallout-ssl-tooltip\nvoid GotoXY(int x, int y)\n```\nSets the text cursor position within the current window."
|
|
7789
|
+
"value": "```fallout-ssl-tooltip\nvoid GotoXY(int x, int y)\n```\n|||\n|:-|:-|\n|`x`| Text cursor X position in the current window|\n|`y`| Text cursor Y position in the current window|\n\nSets the text cursor position within the current window."
|
|
7810
7790
|
}
|
|
7811
7791
|
},
|
|
7812
7792
|
{
|
|
@@ -7836,7 +7816,7 @@
|
|
|
7836
7816
|
"category": "window_functions",
|
|
7837
7817
|
"documentation": {
|
|
7838
7818
|
"kind": "markdown",
|
|
7839
|
-
"value": "```fallout-ssl-tooltip\nvoid MouseShape(string filename, int x, int y)\n```\nLoads a custom mouse cursor graphic from the specified file and sets the hotspot offset."
|
|
7819
|
+
"value": "```fallout-ssl-tooltip\nvoid MouseShape(string filename, int x, int y)\n```\n|||\n|:-|:-|\n|`x`| Hotspot X offset of the cursor|\n|`y`| Hotspot Y offset of the cursor|\n\nLoads a custom mouse cursor graphic from the specified file and sets the hotspot offset."
|
|
7840
7820
|
}
|
|
7841
7821
|
},
|
|
7842
7822
|
{
|
|
@@ -7846,7 +7826,7 @@
|
|
|
7846
7826
|
"category": "window_functions",
|
|
7847
7827
|
"documentation": {
|
|
7848
7828
|
"kind": "markdown",
|
|
7849
|
-
"value": "```fallout-ssl-tooltip\nvoid PrintRect(string value, int param, int alignment)\n```\nPrints a value within a rectangle in the current window with the specified alignment."
|
|
7829
|
+
"value": "```fallout-ssl-tooltip\nvoid PrintRect(string value, int param, int alignment)\n```\n|||\n|:-|:-|\n|`param`| Width in pixels at which the text wraps; scaled to the window|\n|`alignment`| Text alignment: `0` left, `1` right, `2` center|\n\nPrints a value within a rectangle in the current window with the specified alignment."
|
|
7850
7830
|
}
|
|
7851
7831
|
},
|
|
7852
7832
|
{
|
|
@@ -7866,7 +7846,7 @@
|
|
|
7866
7846
|
"category": "window_functions",
|
|
7867
7847
|
"documentation": {
|
|
7868
7848
|
"kind": "markdown",
|
|
7869
|
-
"value": "```fallout-ssl-tooltip\nvoid ResizeWin(string name, int x, int y, int width, int height)\n```\nResizes the named window to the specified position and dimensions. Coordinates are scaled to the current screen resolution."
|
|
7849
|
+
"value": "```fallout-ssl-tooltip\nvoid ResizeWin(string name, int x, int y, int width, int height)\n```\n|||\n|:-|:-|\n|`name`| Name of a window created with `CreateWin`|\n|`x`| X position; scaled to the current screen resolution|\n|`y`| Y position; scaled to the current screen resolution|\n|`width`| Width; scaled to the current screen resolution|\n|`height`| Height; scaled to the current screen resolution|\n\nResizes the named window to the specified position and dimensions. Coordinates are scaled to the current screen resolution."
|
|
7870
7850
|
}
|
|
7871
7851
|
},
|
|
7872
7852
|
{
|
|
@@ -7876,7 +7856,7 @@
|
|
|
7876
7856
|
"category": "window_functions",
|
|
7877
7857
|
"documentation": {
|
|
7878
7858
|
"kind": "markdown",
|
|
7879
|
-
"value": "```fallout-ssl-tooltip\nvoid ScaleWin(string name, int x, int y, int width, int height)\n```\nScales the named window to the specified position and dimensions."
|
|
7859
|
+
"value": "```fallout-ssl-tooltip\nvoid ScaleWin(string name, int x, int y, int width, int height)\n```\n|||\n|:-|:-|\n|`name`| Name of a window created with `CreateWin`|\n|`x`| X position|\n|`y`| Y position|\n|`width`| Width|\n|`height`| Height|\n\nScales the named window to the specified position and dimensions."
|
|
7880
7860
|
}
|
|
7881
7861
|
},
|
|
7882
7862
|
{
|
|
@@ -7886,7 +7866,7 @@
|
|
|
7886
7866
|
"category": "window_functions",
|
|
7887
7867
|
"documentation": {
|
|
7888
7868
|
"kind": "markdown",
|
|
7889
|
-
"value": "```fallout-ssl-tooltip\nvoid SelectFileList(string pattern, string title)\n```\nOpens a file picker dialog with the given file pattern and title."
|
|
7869
|
+
"value": "```fallout-ssl-tooltip\nvoid SelectFileList(string pattern, string title)\n```\n|||\n|:-|:-|\n|`pattern`| File pattern to list|\n\nOpens a file picker dialog with the given file pattern and title."
|
|
7890
7870
|
}
|
|
7891
7871
|
},
|
|
7892
7872
|
{
|
|
@@ -7896,7 +7876,7 @@
|
|
|
7896
7876
|
"category": "window_functions",
|
|
7897
7877
|
"documentation": {
|
|
7898
7878
|
"kind": "markdown",
|
|
7899
|
-
"value": "```fallout-ssl-tooltip\nvoid SelectWin(string name)\n```\nSelects the named window as the current target for subsequent drawing and widget operations."
|
|
7879
|
+
"value": "```fallout-ssl-tooltip\nvoid SelectWin(string name)\n```\n|||\n|:-|:-|\n|`name`| Name of a window created with `CreateWin`|\n\nSelects the named window as the current target for subsequent drawing and widget operations."
|
|
7900
7880
|
}
|
|
7901
7881
|
},
|
|
7902
7882
|
{
|
|
@@ -7976,7 +7956,7 @@
|
|
|
7976
7956
|
"category": "window_functions",
|
|
7977
7957
|
"documentation": {
|
|
7978
7958
|
"kind": "markdown",
|
|
7979
|
-
"value": "```fallout-ssl-tooltip\nvoid format(string text, int x, int y, int width, int height, int alignment)\n```\nFormats and displays text within a specified rectangle in the current window, with the given alignment."
|
|
7959
|
+
"value": "```fallout-ssl-tooltip\nvoid format(string text, int x, int y, int width, int height, int alignment)\n```\n|||\n|:-|:-|\n|`x`| X position in the current window|\n|`y`| Y position in the current window|\n|`width`| Width of the text rectangle in pixels|\n|`height`| Height of the text rectangle in pixels|\n|`alignment`| Text alignment: `0` left, `1` right, `2` center|\n\nFormats and displays text within a specified rectangle in the current window, with the given alignment."
|
|
7980
7960
|
}
|
|
7981
7961
|
},
|
|
7982
7962
|
{
|