Modding Tools

Description

This mod is primarily intended for modders.

Unit Manipulation System

Get reference to mod.

local modding_tools = get_mod("modding_tools")

Check if unit manipulation system is busy.

Returns True if any unit is currently being moved / rotated / scaled otherwise nil.

local busy = modding_tools:unit_manipulation_busy()

Add a unit to the manipulation system.

modding_tools:unit_manipulation_add(unit, camera, world, gui, name)

Remove a unit from the manipulation system.

modding_tools:unit_manipulation_remove(unit)

Remove all units from the manipulation system.

modding_tools:unit_manipulation_remove_all()

Programmatically select a unit.

modding_tools:unit_manipulation_select(unit)

Deselect current unit.

modding_tools:unit_manipulation_deselect()

Get all unit manipulation extensions.

modding_tools:unit_manipulation_extensions()

Position, Rotation and Scale are immediately applied to the unit.

However in case of units that are continously positioned the offset is also stored in the unit data.

local position_offset = Unit.get_data(unit, "unit_manipulation_position_offset")

local rotation_offset = Unit.get_data(unit, "unit_manipulation_rotation_offset")

local scale_offset    = Unit.get_data(unit, "unit_manipulation_scale_offset")

-

-

Console

DMF mod:echo and some other functions can be redirected to automatically print to the new console.

Printing a table to the console results in an entry that can be clicked with the mouse to open the table in the inspector.

Print to console. Takes multiple args.

modding_tools:console_print(...)

Inspector

-

DMF mod:dtf can be redirected to open a table in the inspector instead of writing it to a file.