Mlog Documentation

https://yrueii.github.io/MlogDocs
Admin
Mlog Documentation provides comprehensive guides and references for the Mlog scripting language,...
Tokens:36,612
Snippets:334
Trust Score:8.3
Update:9 months ago
Show doc for...
Tokens:
Raw
### Getting Link Count and Instructions Per Tick

Source: https://yrueii.github.io/MlogDocs/index

Demonstrates how to use '@links' to get the number of buildings connected to the processor and '@ipt' to find out how many instructions are executed per tick.

```Mindustry Script
set linkCount = @links
set instructionsPerTick = @ipt
```

--------------------------------

### Using Mathematical Constants

Source: https://yrueii.github.io/MlogDocs/index

Shows examples of using built-in mathematical constants like '@pi' for calculations and '@degToRad' for converting degrees to radians.

```Mindustry Script
set piValue = @pi
set radians = 90 * @degToRad
```

--------------------------------

### Universal Switch Logic Example

Source: https://yrueii.github.io/MlogDocs/index

A simple logic schematic demonstrating a universal switch. It uses sensors and conditional jumps to control the enabled state of a target block based on a switch's state.

```APIDOC
## Universal Switch Logic Example

### Description
This logic schematic demonstrates a universal switch. It uses sensors to read states and conditional jumps to control the 'enabled' property of a target block.

### Method
Not applicable (logic schematic)

### Endpoint
Not applicable (logic schematic)

### Parameters
Not applicable (logic schematic)

### Request Example
This is a logic schematic, not an API call. The lines represent sequential operations within the Mlog system.

### Response
Not applicable (logic schematic)

**Logic Breakdown:**
* **Line 0:** Sensor for `@enabled` in `switch1`, stores the state in the `switch` variable.
* **Line 1:** Get link with `link`, which is an incrementing variable.
* **Line 2:** Sensor for `@type` in `block` for later use.
* **Line 3:** Increment the variable `link`.
* **Line 4:** Resets the variable `link` when it reaches `@links` using the modulo operator (`%`).
* **Line 5:** Jump if `type` is `@switch`. This ensures the switch building itself is not controlled.
* **Line 6:** Control the `enabled` state of `block`, which is the result of `getlink`, to match the `switch` variable's state.
```

--------------------------------

### Getting Unit Cap

Source: https://yrueii.github.io/MlogDocs/index

Workarounds for determining the unit cap in Mindustry.

```APIDOC
## Getting Unit Cap

### Description
There is no direct way to consistently retrieve the unit cap. Workarounds involve counting cores on the map and their types. Based on the core type (Shard: 8, Foundation: 16, Nucleus: 24), the unit cap can be calculated, assuming default caps are unchanged.
```

--------------------------------

### Get Tile Information

Source: https://yrueii.github.io/MlogDocs/index

This function retrieves specific information about a tile at given coordinates. It can fetch details like the floor type, ore present, the block name, or the building reference. The 'get' parameter determines the type of information returned.

```plaintext
get tile info (get=<floor|ore|block|building>, at: x, y)
```

--------------------------------

### Mindustry Flag Commands

Source: https://yrueii.github.io/MlogDocs/index

Commands for getting and setting flags, which are boolean values that can be used to track states or conditions.

```plaintext
getflag result "flag"

setflag "flag" true
```

--------------------------------

### Incrementing a Variable in a Processor Loop

Source: https://yrueii.github.io/MlogDocs/index

Shows how to increment a variable 'x' by 1 in each processor loop cycle. This is a fundamental example of variable incrementation in Mindustry scripting.

```Mindustry Script
set x = x + 1
```

--------------------------------

### Flush Display in MLog

Source: https://yrueii.github.io/MlogDocs/MlogInvention/index

This snippet demonstrates the 'flush' operation in MLog, which is used to update the display. It includes drawing a background rectangle and an example of incrementing a number.

```MLog
flush:
    drawflush display1
        draw rect bgx yloc bgwidth sizey #background, alter as needed
        op add number number 1 #add 1 to [number] (incremental demonstration), alter as needed
    set val number
    set xloc1 xloc
    jump loop always
```

--------------------------------

### Spawn Scathe Missile - MLOG

Source: https://yrueii.github.io/MlogDocs/index

Describes the process of spawning a Scathe missile. This involves spawning a unit capable of carrying a payload, setting the payload to 'scathe-missile' using `setprop`, making the unit drop the payload, and then killing the unit. You can also use `fetch` with '@scathe-missile' to get a reference for `setprop`.

```mlog
// To spawn a Scathe missile:
// 1. Spawn a unit capable of carrying a payload.
// 2. Use `setprop` to set that unit's payload to '@scathe-missile'.
// 3. Make the unit drop the payload.
// 4. Kill the unit.
// Example using fetch to get missile reference:
// sensor missileRef = fetch @scathe-missile
// setprop missileRef health 100 // Example property modification
```

--------------------------------

### Using @counter to Jump to an Instruction

Source: https://yrueii.github.io/MlogDocs/index

Example of using the built-in '@counter' variable to control program flow. Setting '@counter' to a specific instruction number effectively creates a jump. Reading '@counter' returns the next instruction's line number.

```Mindustry Script
set @counter = 10
// ... some instructions ...
set x = @counter // If this set is at line 10, x will be 11
```

--------------------------------

### Mlog Label Example 1: Using 'jump 1'

Source: https://yrueii.github.io/MlogDocs/MlogLabeler/index

This snippet demonstrates a basic Mlog label usage by jumping to the next line (line 1) using the 'jump 1' instruction. It initializes a counter, prints 'frog1', increments the counter, and then jumps if the counter is less than 2. If the condition is met, it prints 'frog2'.

```mlog
set i 0 print "frog1" op add i i 1 jump 1 lessThan i 2 print "frog2" printflush message1                 
```

--------------------------------

### Fetch Object/Count

Source: https://yrueii.github.io/MlogDocs/index

Retrieves references to units, players, cores, or buildings by index, or gets the total count of these entities. Handles dynamic index changes when objects are destroyed.

```APIDOC
## GET /api/fetch

### Description
Fetches references to game objects (units, players, cores, buildings) by index or retrieves their total counts.

### Method
GET

### Endpoint
/api/fetch

### Parameters
#### Query Parameters
- **type** (string) - Required - The type of object to fetch. Options: `unit`, `player`, `core`, `building`, `unitCount`, `playerCount`, `coreCount`, `buildCount`.
- **team** (string) - Optional - The team to filter by (e.g., `@sharded`). Required for fetching specific objects, not for counts.
- **index** (number) - Optional - The index of the object to fetch (starts at 0). Required for fetching specific objects, not for counts.
- **result** (string) - Required - The name of the variable to store the result in.

### Request Example
```http
GET /api/fetch?type=unit&team=@player&index=0&result=myUnitRef
GET /api/fetch?type=unitCount&result=totalUnits
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.
- **value** (any) - The fetched object reference or count.

#### Response Example
```json
{
  "status": "success",
  "value": { ... unit object ... } 
}
```
```json
{
  "status": "success",
  "value": 150
}
```
```

--------------------------------

### Variable: Camera X/Y Position (@cameraX, @cameraY)

Source: https://yrueii.github.io/MlogDocs/index

Retrieves the X or Y coordinates of an object's camera in the map's coordinate system. Allows independent camera movement tracking. Example: `sensor x @unit @cameraX`.

```mlog
sensor <output_var> @cameraX <object>
sensor <output_var> @cameraY <object>
```

--------------------------------

### Get Unit Current Ammo Type - MLOG

Source: https://yrueii.github.io/MlogDocs/index

Returns the type of ammunition currently used by a turret. For example, if 'duo1' is using copper as ammo, this will return '@copper'.

```mlog
sensor result = @currentAmmoType in duo1
```

--------------------------------

### Get Unit Total Payload - MLOG

Source: https://yrueii.github.io/MlogDocs/index

Retrieves the total payload carried by a unit, calculated per tile. For example, a 2x2 block counts as 4. If the unit carries an item, it returns the sum of the item's size. If it carries another unit, it returns the unit's size.

```mlog
sensor result = @totalPayload in @unit
```

--------------------------------

### Setting and Using Variables with Operations

Source: https://yrueii.github.io/MlogDocs/index

Illustrates how to declare a variable 'x' and assign it a value, then use it in an arithmetic operation. The result of the operation is stored in another variable named 'result'.

```Mindustry Script
set x = 10
set result = x + 5
```

--------------------------------

### Read and Write Instructions

Source: https://yrueii.github.io/MlogDocs/index

Enables direct reading and writing to variables in other processors, and accessing individual characters in strings or pixels on a canvas.

```APIDOC
## Read and Write

### Description
Supports reading and writing directly to another processor's variables by specifying the processor reference in the `to` field. Also allows reading individual characters from strings (returning UTF-16 values) and accessing individual pixels on the erekir canvas. Characters on a message block can be accessed by index, returning their UTF-16 value or `null` if out of range.

### Examples
- Writing to another processor:
  `// Assuming 'processor2' has a variable 'myVar'
  write myVar to processor2.myVar // Sets processor2.myVar to the value of myVar`

- Reading a character from a string:
  `read result = "Mindustry" at 0 // result will be 77 (UTF-16 for 'M')`

- Accessing a message block character:
  `read charValue = messageBlock[2] // Gets the UTF-16 value of the character at index 2`
```

--------------------------------

### Get Display Dimensions - MLOG

Source: https://yrueii.github.io/MlogDocs/index

Retrieves the display height and width of a display in pixels.

```mlog
@displayHeight
@displayWidth
```

--------------------------------

### Draw Image Instruction

Source: https://yrueii.github.io/MlogDocs/index

Draws images, including floors like salt and ice, and supports copying content between displays.

```APIDOC
## Draw Image

### Description
Draws various image contents, including floors like '@salt' and '@ice'. It can also copy the contents of one display to another. The copied content is subject to subsequent draw transformations (translate, scale, rotate) and its origin is the center of the source display.

### Usage
- Drawing an image:
  `draw image [x] [y] [image_source] [width] [height]`

- Copying display content:
  `draw image [x] [y] [source_display] [width] [height]`
  `drawflush [destination_display]`

### Parameters
- `x` (number) - The x-coordinate for drawing.
- `y` (number) - The y-coordinate for drawing.
- `image_source` (any) - The source of the image (e.g., block reference, display reference).
- `width` (number) - The width of the image to draw.
- `height` (number) - The height of the image to draw.
```

--------------------------------

### Format Instruction

Source: https://yrueii.github.io/MlogDocs/index

Allows embedding variables within strings using a placeholder format similar to Python's f-strings.

```APIDOC
## Format

### Description
Enables embedding variables (integers, floats, strings) directly within a string literal. This is achieved using numerical placeholders `{0}`, `{1}`, etc., which correspond to the order of variables provided.

### Usage
`format "String text {0} {1}" variable1 variable2`

### Parameters
- `format_string` (string) - The string containing placeholders.
- `variable1`, `variable2`, ... (any) - The variables to be inserted into the placeholders.
```

--------------------------------

### Unit and Ammo Information

Source: https://yrueii.github.io/MlogDocs/index

Get information about a unit's current ammo type and display properties.

```APIDOC
## @currentAmmoType

### Description
Returns the ammo type currently used by a turret.

### Usage Example
`sensor result @currentAmmoType in duo1`
```

```APIDOC
## @displayHeight and @displayWidth

### Description
Returns the display height and width of a display in pixels.
```

--------------------------------

### Play Sound Instruction

Source: https://yrueii.github.io/MlogDocs/index

Plays a sound effect from the game's sound library with adjustable volume, pitch, and panning.

```APIDOC
## Play Sound

### Description
Plays a sound effect from the game's SFX library. Allows control over volume, pitch (using semitone changes), and stereo panning. The `limit` option prevents the sound from playing if it has already been triggered in the same frame.

### Usage
`playsound [sfx_name] volume:[vol] pitch:[pitch] pan:[pan] limit:[limit]`

### Parameters
- `sfx_name` (string) - The name of the sound effect file (e.g., "@sfx-press").
- `volume` (number) - The volume of the sound (0.0 to 1.0).
- `pitch` (number) - The pitch multiplier. Formula: `2 ^ ([semitone change] / 12)`.
- `pan` (number) - The stereo panning (-1.0 for left, 1.0 for right, 0.0 for center).
- `limit` (boolean) - If true, prevents repeated playback in the same frame.
```

--------------------------------

### Enable World Processors via Console

Source: https://yrueii.github.io/MlogDocs/index

This snippet demonstrates how to make World Processors available in the menu using a console command. It also shows how to enter a playtest mode for editing processors in real-time and how to disable this mode. Note that exiting the world while in playtest mode may not save changes unless auto-save is active.

```plaintext
Blocks.worldProcessor.buildVisibility = BuildVisibility.shown
Vars.state.playtestingMap=Vars.state.map
Vars.state.playtestingMap=null
```

--------------------------------

### Get Unit Payload Capacity - MLOG

Source: https://yrueii.github.io/MlogDocs/index

Retrieves the maximum payload capacity of a unit. For instance, an 'oct' unit has a capacity of 30.25.

```mlog
sensor result = @payloadCapacity in @unit
```

--------------------------------

### Get Flag

Source: https://yrueii.github.io/MlogDocs/index

Reads the value of a global flag previously set using the 'Set Flag' instruction and stores the result in a specified variable.

```APIDOC
## GET /api/getFlag

### Description
Retrieves the current value of a global flag and assigns it to a designated result variable.

### Method
GET

### Endpoint
/api/getFlag

### Parameters
#### Query Parameters
- **flag_name** (string) - Required - The name of the flag to read (enclosed in double quotes).
- **result** (string) - Required - The name of the variable to store the flag's value.

### Request Example
```http
GET /api/getFlag?flag_name="@tutorialComplete"&result=tutorialStatus
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.
- **value** (number) - The value of the flag (0 or 1).

#### Response Example
```json
{
  "status": "success",
  "value": 1
}
```
```

--------------------------------

### Setrule Instructions

Source: https://yrueii.github.io/MlogDocs/index

Introduces new rules for game mechanics, including game over conditions, unit mining speed, and unit drag multipliers.

```APIDOC
## Setrule

### Description
Allows modification of game rules. New rules include `canGameOver` to control game over conditions, `unitMineSpeed` to adjust unit mining speed, and `dragMultiplier` to modify unit drag. 

### Rules
- `canGameOver` (boolean)
- `unitMineSpeed` (number)
- `dragMultiplier` (number)
```

--------------------------------

### Mindustry Fetch Build Command

Source: https://yrueii.github.io/MlogDocs/index

Command to fetch information about built items, such as units or blocks, for a given team and index.

```plaintext
fetch build result @team index block
player
core
unit
unitCount
playerCount
coreCount
unitCount
```

--------------------------------

### Mindustry Text Form Instructions

Source: https://yrueii.github.io/MlogDocs/index

Instructions for the game can be written directly and copied to the clipboard for use.

```plaintext
read result cell1 0

write result cell1 0

draw clear r g b
color r b g a
col n
stroke n
line x y x2 y2
rect x y width height
lineRect x y width height
poly x y sides radius rotation
linePoly x y sides radius rotation
triangle x y x2 y2 x3 y3
image x y @copper size rotation

print "frog"

drawflush display1

printflush message1

getlink result index

control enabled block1 enable
shoot block1 x y shoot
shootp block1 unit shoot
config block1 to
color block1 to

radar filter filter filter distance turret1 order result
any health
enemy shield
ally armor
player maxHealth
attacker
flying
boss
ground


sensor result block1 @copper

set result 0

op add result a b
sub
mul
div
idiv
mod
pow
equal
notEqual
land
lessThan
lessThanEq
greaterThan
greaterThanEq
strictEqual
shl
shr
or
and
xor
not
max
min
angle
angleDiff
len
noise
abs
log
log10
floor
ceil
sqrt
rand
sin
cos
tan
asin
acos
atan

lookup block result index
unit
item
liquid

packcolor result r g b a

wait 0.5

stop

end

jump -1 equal v1 v2
notEqual
lessThan
lessThanEq
greaterThan
greaterThanEq
strictEqual
always


ubind @poly
ucontrol idle
stop
move x y
approach x y radius
pathfind x y
autoPathfind
boost enable
target x y shoot
targetp unit shoot
itemDrop to amount
itemTake from amount
payDrop
payTake takeUnits
payEnter
mine x y
flag value
build x y block rotation config
getBlock x y type building floor
within x y radius result
unbind


uradar any any any distance 0 1 result
enemy distance
ally health
player shield
attacker armor
flying maxHealth
boss
ground

ulocate building core enemy @copper outx outy found building
core
storage
generator
turret
factory
repair
battery
reactor
ulocate ore core true @copper outx outy found building
ulocate spawn core true @copper outx outy found building
ulocate damaged core true @copper outx outy found building
```

--------------------------------

### Get Display Draw Operations - MLOG

Source: https://yrueii.github.io/MlogDocs/index

Returns the count of drawflush operations on a display since the map was reloaded. This can be used to detect if the display needs to be redrawn.

```mlog
@operations
```

--------------------------------

### Print to Text Buffer and Flush

Source: https://yrueii.github.io/MlogDocs/index

Demonstrates how to print text to the internal text buffer and then flush it to a message block. The text buffer has a limit of 400 characters, while the message block has a limit of 220 characters.

```mlog
print "frog"
// ... other operations ...
printFlush
```

--------------------------------

### Lookup Instructions

Source: https://yrueii.github.io/MlogDocs/index

Extends the lookup functionality to include team-based lookups.

```APIDOC
## Lookup

### Description
Lookup operations now support querying based on team affiliation.

### Lookup Type
- `team`
```

--------------------------------

### Draw Operations to Draw Buffer and Flush

Source: https://yrueii.github.io/MlogDocs/index

Illustrates queuing draw operations to the draw buffer and flushing them. The draw buffer has a limit of 256 items, and displays have a limit of 1024 operations per tick. Excess operations beyond these limits are discarded.

```mlog
draw line(0, 0, 10, 10)
// ... up to 255 more draw operations ...
drawFlush
```

--------------------------------

### Set Flag

Source: https://yrueii.github.io/MlogDocs/index

Sets a global flag (global variable) with a value of either 0 or 1 (true or false). These flags can be read by other game logic using the 'Get Flag' instruction.

```APIDOC
## POST /api/setFlag

### Description
Establishes or updates a global flag with a binary value (0 or 1).

### Method
POST

### Endpoint
/api/setFlag

### Parameters
#### Request Body
- **flag_name** (string) - Required - The name of the flag (enclosed in double quotes).
- **value** (number) - Required - The value of the flag (0 or 1).

### Request Example
```json
{
  "flag_name": "@tutorialComplete",
  "value": 1
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Accessing Processor and Map Coordinates

Source: https://yrueii.github.io/MlogDocs/index

Shows how to retrieve the current processor's coordinates using '@thisx' and '@thisy', and the map dimensions using '@mapw' and '@maph'.

```Mindustry Script
set procX = @thisx
set procY = @thisy
set mapWidth = @mapw
set mapHeight = @maph
```

--------------------------------

### Variable: Memory Capacity (@memoryCapacity)

Source: https://yrueii.github.io/MlogDocs/index

Retrieves the storage capacity of a specified memory cell or bank. This is useful for understanding the limits of memory storage in scripts. Example: `sensor memory = @memoryCapacity in bank1` returns 512.

```mlog
sensor <output_var> @memoryCapacity in <memory_bank>
```

--------------------------------

### Variable: String Length (@size)

Source: https://yrueii.github.io/MlogDocs/index

Returns the length of a given string. This variable can be used to determine the number of characters in a string. Example: `sensor length = @size in "Mindustry"` will result in `length` being 9.

```mlog
sensor <output_var> @size in "<string>"
```

--------------------------------

### Assigning Building Reference to a Variable

Source: https://yrueii.github.io/MlogDocs/index

Demonstrates how to copy a building reference from a display variable to a custom variable. The custom variable becomes an independent copy that retains its value even if the original building is destroyed.

```Mindustry Script
set myBuilding = display1
```

--------------------------------

### Variable: Object Solidness (@solid)

Source: https://yrueii.github.io/MlogDocs/index

Returns the solidness property of an object. A value of 0 typically indicates a non-solid object (like a conveyor), while 1 indicates a solid object (like a wall). Example: `sensor s conveyor1 @solid`.

```mlog
sensor <output_var> @solid <object>
```

--------------------------------

### Using @this as a Building Reference

Source: https://yrueii.github.io/MlogDocs/index

Demonstrates replacing a specific processor's name (e.g., 'processor1') with the built-in '@this' variable, which refers to the processor executing the script.

```Mindustry Script
set myBuilding = @this
```

--------------------------------

### Control Instructions and Mindustry Coordinate System

Source: https://yrueii.github.io/MlogDocs/index

Details on control instructions and the unique coordinate system used in Mindustry.

```APIDOC
## Control Instruction

### Description
The control instruction can manage any block within the processor's range, not just those directly connected to it.
```

```APIDOC
## Mindustry Coordinate System

### Description
Mindustry uses a Cartesian coordinate system where the center of a block is the origin (0,0), offset by 0.5 from traditional systems. The world origin (0,0) is at the bottom-left, resulting in positive coordinates for the playfield.
```

--------------------------------

### Get Display Buffer Usage - MLOG

Source: https://yrueii.github.io/MlogDocs/index

Returns the number of commands currently in a display's graphics buffer. This is useful for determining when to flush the buffer. When used on a message block, it returns the total string/character length, not the text buffer length.

```mlog
@bufferUsage
```

--------------------------------

### Display and Operation Commands

Source: https://yrueii.github.io/MlogDocs/index

Commands related to display graphics buffer and operation counts.

```APIDOC
## @bufferUsage

### Description
Returns the number of commands currently in a display's graphics buffer. This is useful for determining when to flush the buffer. It also returns the total string/character length when used on a message block, but not the length of the text buffer.
```

```APIDOC
## @operations

### Description
Returns the number of drawflush operations on a display since the map reload. This can help detect when a display needs to be redrawn.
```

--------------------------------

### Variable: Camera Width/Height (@cameraWidth, @cameraHeight)

Source: https://yrueii.github.io/MlogDocs/index

Retrieves the width or height of an object's camera view in blocks. Typically used for player-controlled units or turrets. Returns 0 if the object does not have a camera. Example: `sensor width @unit @cameraWidth`.

```mlog
sensor <output_var> @cameraWidth <object>
sensor <output_var> @cameraHeight <object>
```

--------------------------------

### Operation: Euclidean Modulo (op emod)

Source: https://yrueii.github.io/MlogDocs/index

Calculates the Euclidean modulo, ensuring a positive result. This is particularly useful for mathematical operations where a non-negative remainder is required, such as in cryptography or number theory. Example: `op emod result -3 5` returns 2.

```mlog
op emod result dividend divisor
```

--------------------------------

### Operation: Logarithm Calculation (op logn)

Source: https://yrueii.github.io/MlogDocs/index

Computes the logarithm of a number with a specified base. The result indicates the power to which the base must be raised to obtain the number. Example: `op logn result 1000 10` computes log base 10 of 1000.

```mlog
op logn result number base
```

--------------------------------

### MLog Variable Renaming and Scathe Missile Spawning

Source: https://yrueii.github.io/MlogDocs/index

Information on the renaming of 'configure' to 'config' and the procedure for spawning Scathe missiles.

```APIDOC
## Configure to Config Renaming

### Description
In v6, the property `configure` was renamed to `config`. For backward compatibility, the game automatically converts `configure` to `config`. Using `configure` as a variable name is still functional, but it cannot be used directly anymore.
```

```APIDOC
## Spawning Scathe Missile

### Description
To spawn a Scathe missile, you must first spawn a unit capable of carrying a payload, set its payload to Scathe missile using `setprop` and `@scathe-missile`, then make the unit drop the payload, and finally kill the unit. You can also set properties of the Scathe missile itself using `setprop` after fetching its reference with `fetch @scathe-missile`.
```

--------------------------------

### Accessing Game Time Variables

Source: https://yrueii.github.io/MlogDocs/index

Illustrates how to access different time-related built-in variables: '@time' (milliseconds), '@tick' (ticks), '@second' (seconds), and '@minute' (minutes).

```Mindustry Script
set currentTimeMs = @time
set currentTick = @tick
set currentSecond = @second
set currentMinute = @minute
```

--------------------------------

### Variable: Object Velocity (@velocityX, @velocityY)

Source: https://yrueii.github.io/MlogDocs/index

Retrieves an object's velocity along the X or Y axis in blocks per second. Can be used with `op len` to determine the object's speed. Also available in `setprop`. Example: `sensor vx @unit @velocityX`.

```mlog
sensor <output_var> @velocityX <object>
sensor <output_var> @velocityY <object>
```

--------------------------------

### Make Marker API

Source: https://yrueii.github.io/MlogDocs/index

This API allows you to create and define new markers on the map. Markers can represent various entities like selected units, movement paths, or tutorial text.

```APIDOC
## MAKE MARKER API

### Description
Creates a marker on the map. Markers are entities that display information to the user, such as selection boxes, movement lines, or tutorial text.

### Method
Not specified, likely a function call within the game's scripting environment.

### Endpoint
N/A (Internal game function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **id** (integer) - Required - A unique numeric identifier for the marker (32-bit signed integer). Values outside the range will be clamped. The total number of markers is limited to 20,000.
- **x** (float) - Required - The x-coordinate of the marker's location.
- **y** (float) - Required - The y-coordinate of the marker's location.
- **replace** (boolean) - Optional - Determines if this marker should replace existing markers with the same ID. Recommended to keep `false` due to a known bug.
- **shapeText** (object) - Optional - Defines a marker with a rectangular shape and text above it.
- **point** (object) - Optional - Defines a marker as an expanding red circle.
- **shape** (object) - Optional - Defines a simple rectangular marker.
- **text** (object) - Optional - Defines a marker as text with a semi-transparent black background.
- **line** (object) - Optional - Defines a marker as a line.
- **Texture** (object) - Optional - Defines a marker for a Texture. Initially invisible until a texture is defined using `setmarker texture`.
- **Quad** (object) - Optional - Defines a quadrilateral marker (4-sided polygon). Vertices can be set using `setmarker posi`, and texture can be applied using `setmarker texture` and mapped with `setmarker uvi`.

### Request Example
```json
{
  "id": 1,
  "x": 100,
  "y": 50,
  "shape": {},
  "text": {
    "value": "My Marker Text"
  }
}
```

### Response
#### Success Response (200)
Marker creation is typically a side effect, no explicit success response body is usually returned.

#### Response Example
None
```

--------------------------------

### Operation: Unsigned Right Shift (op ushr)

Source: https://yrueii.github.io/MlogDocs/index

Performs an unsigned right bitwise shift operation. This shifts the bits of a number to the right, filling the leftmost bits with zeros, regardless of the sign of the original number. Example: `op ushr result -8 1` shifts -8 right by 1 bit unsigned.

```mlog
op ushr result number shift_amount
```
Tokens:
Raw