@bgforge/mls-server 3.0.1

package/out/engine-proc-docs.json

@@ -0,0 +1,29 @@
+{
+    "barter_init_p_proc": "Called when the barter screen is initialized.",
+    "barter_p_proc": "Called when the player initiates bartering with the critter.",
+    "combat_is_over_p_proc": "Called every time before combat ends.",
+    "combat_is_starting_p_proc": "Called every time before the start of combat.",
+    "combat_p_proc": "Called in combat (every turn?). The specific combat event number is passed via `fixed_param`.",
+    "create_p_proc": "Called when the object is first created on the map.",
+    "critter_p_proc": "This procedure is called every \"heartbeat\", which means it's run ten times each second, except during combat.\nNote: if this procedure is not present in the script, errors can occur, and the first encountered procedure may be treated as this handler.",
+    "damage_p_proc": "Called when the critter takes damage. The amount of damage received is passed via `fixed_param`.\nNote: not called if the damage is fully absorbed by armor.",
+    "description_p_proc": "Called when the player inspects the object (binoculars). By default, the description from the prototype object is shown.\nNote: must use `script_overrides` to prevent simultaneous execution with the default description.",
+    "destroy_p_proc": "Called on death of the critter or destruction of the object (except when using `destroy_object(self_obj)`).",
+    "drop_p_proc": "Called when the self-object is dropped to the ground.",
+    "is_dropping_p_proc": "Called when trying to drop an object.",
+    "look_at_p_proc": "Called when the player passes the cursor over any object. By default, the prototype name of the object is displayed.\nNote: must use `script_overrides` to prevent simultaneous execution with the default name display.",
+    "map_enter_p_proc": "Called once by the engine each time the map is entered from another map. It is not run when the elevation is changed.",
+    "map_exit_p_proc": "Called when the player leaves the map.",
+    "map_update_p_proc": "Called every 250 game ticks (1 tick = 1/10 second, so roughly every 25 seconds). It is also called each time you exit a dialogue, each time you exit the pipboy screen and each time you use an item. In addition to that, it is run once when you enter the map, and, seemingly, twice when you change elevation.",
+    "pickup_p_proc": "In object scripts, called when a critter tries to pick up this item.\nFor container objects, called when a critter tries to open them or steal something.\nIn critter scripts, called when someone tries to steal from this critter.",
+    "push_p_proc": "Called when trying to push the object.",
+    "spatial_p_proc": "Called when an object passes over the self-object's spatial trigger area.",
+    "start": "Called by the engine when the script is first run or the game object is first created, then never again, unless specifically called from somewhere else.",
+    "talk_p_proc": "Called when the player tries to initiate dialogue with the critter.",
+    "timed_event_p_proc": "This procedure is called by the function `add_timer_event(ObjPtr obj, int time, int fixed_param)`.\n`ObjPtr` points to the object whose script's `timed_event_p_proc` procedure you want to access.\nTime is the number of game ticks (1 game tick = 1/10 seconds) you want to pass before the `timed_event_p_proc` is called.\n`fixed_param` is a variable you can set to differentiate between various timed events.\nIn `timed_event_p_proc`, you can check the value of `fixed_param` against whatever number you used when calling `add_timer_event`.\nThis allows for multiple uses of `timed_event_p_proc` in the same script.",
+    "use_ad_on_p_proc": "Called when an advantage is used on the object.",
+    "use_disad_on_p_proc": "Called when a disadvantage is used on the object.",
+    "use_obj_on_p_proc": "Called when:\n- A critter uses an object on another critter. (Or themselves).\n- A critter uses an object from inventory screen AND this object does not have \"Use\" action flag set and it's not active flare or explosive.\n- Player or AI uses any drug.\nThe parameter `obj_being_used_with` receives a pointer to the object that was used.",
+    "use_p_proc": "Called when:\n- A critter uses an object from inventory which have \"Use\" action flag set or it's an active flare or dynamite.\n- Player uses an object from main interface.\nUse `source_obj` to get the object being used. Note: not called for some item types when working with inventory.",
+    "use_skill_on_p_proc": "Called when a skill is used on the object. The skill number is passed via `action_being_used` (see DEFINE.H, Skill Equates)."
+}

package/out/engine-procedures.json

@@ -0,0 +1,29 @@
+[
+    "barter_init_p_proc",
+    "barter_p_proc",
+    "combat_is_over_p_proc",
+    "combat_is_starting_p_proc",
+    "combat_p_proc",
+    "create_p_proc",
+    "critter_p_proc",
+    "damage_p_proc",
+    "description_p_proc",
+    "destroy_p_proc",
+    "drop_p_proc",
+    "is_dropping_p_proc",
+    "look_at_p_proc",
+    "map_enter_p_proc",
+    "map_exit_p_proc",
+    "map_update_p_proc",
+    "pickup_p_proc",
+    "push_p_proc",
+    "spatial_p_proc",
+    "start",
+    "talk_p_proc",
+    "timed_event_p_proc",
+    "use_ad_on_p_proc",
+    "use_disad_on_p_proc",
+    "use_obj_on_p_proc",
+    "use_p_proc",
+    "use_skill_on_p_proc"
+]