dual-universe / lua-examples

This repository has been created to serve as a sharing and learning platform for the Dual Universe community and the development of simple and complex Lua applications. You will find on this repo the examples released by Novaquark during the devblog and thread.

Official Dual Universe Lua Repository

What is Dual Universe

Dual Universe is a sci-fi MMORPG that takes place in a continuous, single-shard world. Players can freely modify the world by creating structures, spaceships, and even orbital stations, giving birth to empires and civilizations. It features a player-driven economy, politics, trade, and warfare.

Dual Universe is currently in open Beta, with a final release planned for 2022.

Official website: https://www.dualuniverse.game

About this repository

This repository has been created to serve as a sharing and learning platform for the Dual Universe community and the development of simple and complex Lua applications.

You will find on this repo the examples released by Novaquark in devblogs and other announcements of features along with other snippets we deem useful for the community.

Reminder: As the Lua feature evolves regularly, it is possible that a script or system may be broken or contain bugs. We will try to update the relevant examples if this is the case, but no guarantee of functionality can be given.

How to use it ?

Each example provided here consists of the following:

• A description of the example.
• An image representing the result (if possible).
• A list of requirements (which elements/links are needed to use the system).
• Installation instructions.

In order to ensure the readability of the code, and to cover as many cases as possible, we have decided to organise the code into files by filters. Also in some cases, when the examples are simple and small, we have decided to group them together to reduce clutter.

Thus you will find in the examples folder Lua files named according to the convention <slot>_<filter><index>.

For example:

• render.lua : code for the Lua screen's renderscript.
• controlunit.json : string for use with control units using the Paste Lua configuration from clipboard functionality in game.
• system_onStart.lua : code for the onStart filter of the system slot
• system_onUpdate.lua: code for the onUpdate filter in the system slot
• unit_onTimer1.lua : code for the first onTimer filter in the unit slot
• ...etc

Then, by following the instructions given, you can install these as required.

lua-examples's Issues

core.getWorldVertical misleading

core.getWorldVertical actually points downwards, ie same direction as gravity. There should be documentation specifying the direction.

Documentation error

lua-examples/api-mockup/coreunit.lua

Line 202 in 2d20d50

---@return number value The maximum hitpoints of the Element

This snippet of code.

    --- Returns the mass of the Element, identified by its local ID
    ---@param localId integer The local ID of the Element
    ---@return number value The maximum hitpoints of the Element
    function self.getElementMassById(localId) end

The ---@return number value The maximum hitpoints of the Element should not be about maximum hitpoints but the mass of the element.

Returns unusual values

lua-examples/api-mockup/container.lua

Line 37 in d9ed4cb

function self.getContent() end

Calling this results in a returned table that contains the values "pack remove concat unpack sort move insert" rather than ID and quantity pairs as described.

Copy and paste error in coreunit.lua

I think there's some copy and paste error in coreunit.lua line 50, where the deprecation warning referes to a non existing function construct.getSchematic()

lua-examples/api-mockup/coreunit.lua

Line 50 in ffde629

function self.getSchematicInfo(schematicId) error("CoreUnit.getSchematicInfo() is deprecated, use construct.getSchematic(id) instead.") end

Wrong require, should be "element", not "engine"

lua-examples/api-mockup/databank.lua

Line 11 in fa8463e

require("engine")

Issues with the Atlas screen example

Hi
Not sure if it is me or an update but for some reason when I paste the render.lua code into the screen I get a script error:

attempt to index a number value(local 'v').

Copy&paste error in deprecation warning in coreunit.lua

lua-examples/api-mockup/coreunit.lua

Line 183 in e8ff13f

function self.getElementTypeById(localId) error("CoreUnit.getCycleCountSinceStartup(localId) is deprecated, use CoreUnit.getElementDisplayNameById(localId) instead.") end

function self.getElementTypeById(localId) error("CoreUnit.getCycleCountSinceStartup(localId)...

Request for new function - Render script get player

Is there any chance we could get a function in the render script that makes screens aware on whoms player client it runs, returning the player id/name?
That would be usefull to design screens used by multiple users simultanous and distinguish between their inputs.

getHeliosPosition()

I need a variable of the actual position of helios to calculate the sunrise of the actual player position.
Or something else thats let me calculate the start/end of the day/night-cycle at the player-position.

Gunner Seat Radar Issues

Hello,

I am not sure where the issue lies here. When I apply my custom gunner seat script to my chair, I see this in the gunner periscope view.




However, when I apply the default PvP gun script I see this




I at first assumed it was the data I was sending into the radar widget (either incomplete or something else going on). But upon inspecting the json output of the radar (radar_1.getWidgetData()) from the default script and the radar data fed into the radar widget using my script, I did not find any substantial differences that would account for this behavior.

Default Data

{
    "constructsList": [
        {
            "constructId": "5741688",
            "distance": 11.509540326447041,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "CargoBox",
            "size": "XS",
            "targetThreatState": 0
        },
        {
            "constructId": "5411110",
            "distance": 10126.263601605886,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "N299 Mule the Man",
            "size": "XS",
            "targetThreatState": 0
        },
        {
            "constructId": "5719823",
            "distance": 10380.199691765596,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "PT01",
            "size": "S",
            "targetThreatState": 0
        },
        {
            "constructId": "5638631",
            "distance": 10544.990016054106,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "OMEGA",
            "size": "XS",
            "targetThreatState": 0
        },
        {
            "constructId": "5567993",
            "distance": 10649.402865996866,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "Sava Yesh II",
            "size": "S",
            "targetThreatState": 0
        },
        {
            "constructId": "5658583",
            "distance": 10926.713352488552,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "IC Navis",
            "size": "S",
            "targetThreatState": 0
        },
        {
            "constructId": "5711924",
            "distance": 10927.432673085657,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "Twintania Base",
            "size": "M",
            "targetThreatState": 0
        },
        {
            "constructId": "5690586",
            "distance": 10928.499615752093,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "IC Navis Node",
            "size": "XS",
            "targetThreatState": 0
        },
        {
            "constructId": "5277227",
            "distance": 127134.15874474417,
            "inIdentifyRange": false,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "Hope II",
            "size": "S",
            "targetThreatState": 0
        }
    ],
    "currentTargetId": "0",
    "elementId": "2753861252",
    "helperId": "radar",
    "name": "Advanced Phased-Array Space Radar s [54]",
    "properties": {
        "broken": false,
        "errorMessage": "",
        "identifiedConstructs": [],
        "identifyConstructs": {},
        "radarStatus": 1,
        "selectedConstruct": "0",
        "sortMethod": 0,
        "worksInEnvironment": true
    },
    "staticProperties": {
        "maxIdentifiedTargets": 7,
        "ranges": {
            "identify128m": 123750.0,
            "identify16m": 123750.0,
            "identify32m": 123750.0,
            "identify64m": 123750.0,
            "scan": 400000
        },
        "worksInAtmosphere": false,
        "worksInSpace": true
    },
    "type": "radar"
}

Custom Data

{
    "constructsList": [
        {
            "constructId": "5741688",
            "distance": 11.497139005740145,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[688] CargoBox",
            "size": "XS",
            "targetThreatState": 0
        },
        {
            "constructId": "5411110",
            "distance": 10099.410522447579,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[110] N299 Mule the Man",
            "size": "XS",
            "targetThreatState": 0
        },
        {
            "constructId": "5719823",
            "distance": 10353.233454707668,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[823] PT01",
            "size": "S",
            "targetThreatState": 0
        },
        {
            "constructId": "5638631",
            "distance": 10518.049976234788,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[631] OMEGA",
            "size": "XS",
            "targetThreatState": 0
        },
        {
            "constructId": "5567993",
            "distance": 10622.460439595419,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[993] Sava Yesh II",
            "size": "S",
            "targetThreatState": 0
        },
        {
            "constructId": "5658583",
            "distance": 10899.80712623914,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[583] IC Navis",
            "size": "S",
            "targetThreatState": 0
        },
        {
            "constructId": "5711924",
            "distance": 10900.499892057502,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[924] Twintania Base",
            "size": "M",
            "targetThreatState": 0
        },
        {
            "constructId": "5690586",
            "distance": 10901.593723635093,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[586] IC Navis Node",
            "size": "XS",
            "targetThreatState": 0
        },
        {
            "constructId": "5301571",
            "distance": 43194.568586788686,
            "inIdentifyRange": true,
            "info": {},
            "isIdentified": false,
            "myThreatStateToTarget": 0,
            "name": "[571] Baby Bull",
            "size": "XS",
            "targetThreatState": 0
        }
    ],
    "currentTargetId": "0",
    "elementId": "2753861252",
    "helperId": "radar",
    "name": "Advanced Phased-Array Space Radar s [54]",
    "properties": {
        "broken": false,
        "errorMessage": "All-Distance",
        "identifiedConstructs": [],
        "identifyConstructs": {},
        "radarStatus": 1,
        "selectedConstruct": "0",
        "sortMethod": 0,
        "worksInEnvironment": true
    },
    "staticProperties": {
        "maxIdentifiedTargets": 7,
        "ranges": {
            "identify128m": 123750.0,
            "identify16m": 123750.0,
            "identify32m": 123750.0,
            "identify64m": 123750.0,
            "scan": 400000
        },
        "worksInAtmosphere": false,
        "worksInSpace": true
    },
    "type": "radar"
}

Would anyone be able to assist and help me determine what is going on? My custom script is open source and I can link it if it would help with the review. I also tried using and older version of my script (from near the end of Beta) which I 100% know was working properly and it still has this same behavior.

weapon.getStatus() documentation is not up to date

Seems like actual statuses are:

1 - Idle
2 - Firing
3 - ?
4 - Reloading
5 - Unloading
6 - Fire Blocked

lua-examples/api-mockup/weapon.lua

Lines 70 to 72 in d9ed4cb

	--- Returns the current weapon status
	---@return integer status The current status of the weapon (Idle = 1, Firing = 2, Reloading = 3, Unloading = 4)
	function self.getStatus() end