Differences

This shows you the differences between two versions of the page.

--- luafunctionref [2025/01/08 20:48] – [update_get_map_vehicle_by_id] bredroll
+++ luafunctionref [2026/03/03 18:17] (current) – [Loading] bredroll
@@ Line 26: / Line 26: @@
   * library_custom_X.lua
   * screen/hud
 ==== Execution ====
@@ Line 48: / Line 49: @@
 Next is the update cycle, most of the heavy lifting goes on in here, these are where you can introspect the current vehicle, carrier details, weapons, map, nearby units, other players, missiles, etc. graphical/text drawing calls are made from here to draw the various icons and UI elements.
+=== Refresh Rate ===
+I have recently discovered there is another factor that influences how often a script ''update()'' function is called.  The further away from the screen your character is, the larger the update interval. If you leave the bridge and walk down to the flight deck, by the time you get there the bridge screens will update at most only once every two seconds.
 ==== Functions ======
@@ Line 1371: / Line 1377: @@
 Destroyed vehicles have several methods.
-  * ''destroyed:get_position_xz()'' get a ''vec3'' where ''vec3:x()'' is the x coordinate of the destroyed vehicle and ''vec3:y()'' is the z map coordinate of the vehicle (yes, y/z flip don't worry about it)
+  * ''destroyed:get_position_xz()''
-  * ''destroyed:get_team()'' get the team ID of the destroyed vehicle
+    * get a ''vec3'' where ''vec3:x()'' is the x coordinate of the destroyed vehicle and ''vec3:y()'' is the z map coordinate of the vehicle (yes, y/z flip don't worry about it)
-  * ''destroyed:get_factor()'' get float in range 0-1 based on the age of destruction, where 1 is most recent and 0 is oldest.
+  * ''destroyed:get_team()''
+    * get the team ID of the destroyed vehicle
+  * ''destroyed:get_factor()''
+    * get float in range 0-1 based on the age of destruction, where 1 is most recent and 0 is oldest.
 Usable in:
@@ Line 1399: / Line 1408: @@
 ----
-===update_get_map_vehicle_by_id===
+=== update_get_map_vehicle_by_id ===
 Native/C function
 Get an object representing a player or AI controlled unit in game, the unit may be docked or active.
-The HUD can obtain 3D position (lat-lon-alt) information about a unit where the screen scripts can only obtain 2D (lat-lon). The HUD can also not see unit waypoints where as screens can fully get/set waypoint data.
+The HUD can obtain 3D position (lat-lon-alt) information about a unit where the screen scripts can only obtain 2D (lat-lon).
+The HUD can also see unit waypoints since update 1.5.16.
+Bridge screens can fully get/set waypoint data for all units on all teams.
 vehicle objects have many methods, the most commonly used are:
@@ Line 1413: / Line 1426: @@
   * ''vehicle:get_id()''
     * get the vehicle ID number.
+  * ''vehicle:get_definition_index()''
+    * get the vehicle type (a value in the ''e_game_object_type'' table)
+  * ''vehicle:get_team()'' (screen only)
+    * get the vehicle team number
+  * ''vehicle:get_team_id()'' (HUD only)
+    * get the vehicle team number
+  * ''vehicle:get_position_xz()'' (screen only)
+    * get the vehicle 2D position as a ''vec2''
+  * ''vehicle:get_position()'' (HUD only)
+    * get the vehicle 3D position as a ''vec3'' where ''pos:y()'' is the altitude in meters.
 Usable in:
@@ Line 1422: / Line 1445: @@
   * screen_weapons_support.lua
   * vehicle_hud.lua
 Example call:
 ''library_ui.lua''\\
-<code>local attached_vehicle = update_get_map_vehicle_by_id(attached_vehicle_id)</code>
+<code ->
+local attached_vehicle = update_get_map_vehicle_by_id(attached_vehicle_id)
+</code>
 ----
 ===update_get_map_vehicle_by_index===