CC2 Community Wiki

User Tools

Site Tools

Trace: • multiplayer • luafunctionref
luafunctionref

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
luafunctionref [2025/01/08 20:30] – bredrollluafunctionref [2026/03/03 18:17] (current) – [Loading] bredroll
Line 26: Line 26:
   * library_custom_X.lua   * library_custom_X.lua
   * screen/hud   * screen/hud
 +
  
 ==== Execution ==== ==== 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. 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 ====== ==== Functions ======
Line 1202: Line 1208:
  
 Native/C function Native/C function
 +
 +Return ''true'' if the game is running in VR mode.
  
 Usable in: Usable in:
Line 1259: Line 1267:
  
 Native/C function Native/C function
 +
 +Return the localized string for the given index word/phrase from the ''e_loc'' enum table. Eg, in English, the following:
 +<code>
 +update_get_loc(e_loc.upp_paste)
 +</code>
 +Will return "paste".
  
 Usable in: Usable in:
Line 1302: Line 1316:
  
 Native/C function Native/C function
 +
 +Get the ID of the current player.
  
 Usable in: Usable in:
Line 1315: Line 1331:
  
 Native/C function Native/C function
 +
 +Get the team ID of the current player.
  
 Usable in: Usable in:
Line 1329: Line 1347:
  
 Native/C function Native/C function
 +
 +Get the logic tick. This is the game simulation counter starting at zero the moment the map is crated. It increments by one every simulation frame. The game is tuned such that a second of real time covers 30 game ticks.
 +
 +During the span of an ''update'' function call, the value of the current tick will remain the same.
 +
 +It can be thought of as a primitive low-res clock.
  
 Usable in: Usable in:
Line 1348: Line 1372:
  
 Native/C function Native/C function
 +
 +Get an object representing a recently destroyed vehicle. Used along with ''update_get_map_destroyed_vehicle_count()''.
 +
 +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_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: Usable in:
Line 1361: Line 1396:
  
 Native/C function Native/C function
 +
 +Get the number of destroyed vehicles visible on the game map.
  
 Usable in: Usable in:
Line 1371: Line 1408:
  
 ---- ----
-===update_get_map_vehicle_by_id===+=== update_get_map_vehicle_by_id ===
  
 Native/C function 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 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:
 +
 +  * ''vehicle:get()''
 +    * locking/housekeeping, return ''true'' if this object can be used and is valid.
 +  * ''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: Usable in:
Line 1383: Line 1445:
   * screen_weapons_support.lua   * screen_weapons_support.lua
   * vehicle_hud.lua   * vehicle_hud.lua
 +
 Example call: Example call:
  
 ''library_ui.lua''\\ ''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=== ===update_get_map_vehicle_by_index===
  
luafunctionref.1736368225.txt.gz · Last modified: 2025/01/08 20:30 by bredroll
Except where otherwise noted, content on this wiki is licensed under the following license: Public Domain
Public Domain Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki