Vertex

Properties

ceilingZ

The ceiling z position of the Vertex. Only available in UDMF. Only available for supported game configurations.

fields

UDMF fields. It's an object with the fields as properties.

s.fields.comment = 'This is a comment';
s.fields['comment'] = 'This is a comment'; // Also  works
s.fields.xscalefloor = 2.0;
t.fields.score = 100;

It is also possible to define new fields:

s.fields.user_myboolfield = true;

There are some restrictions, though:

  • it only works for fields that are not in the base UDMF standard, since those are handled directly in the respective class
  • it does not work for flags. While they are technically also UDMF fields, they are handled in the flags field of the respective class (where applicable)
  • JavaScript does not distinguish between integer and floating point numbers, it only has floating point numbers (of double precision). For fields where UDB knows that they are integers this it not a problem, since it'll automatically convert the floating point numbers to integers (dropping the fractional part). However, if you need to specify an integer value for an unknown or custom field you have to work around this limitation: Version 5 and later: You can use a BigInt. This is done by appending a n to the number. Note that this is just a convenient way to define whole numbers, it still only supports 32 bit integers:
s.fields.user_myintfield = 25n; // Sets the 'user_myintfield' field to an integer value of 25

In version 4 and earlier you have to use the UniValue class:

s.fields.user_myintfield = new UDB.UniValue(0, 25); // Sets the 'user_myintfield' field to an integer value of 25

To remove a field you have to assign null to it:

s.fields.user_myintfield = null;

floorZ

The floor z position of the Vertex. Only available in UDMF. Only available for supported game configurations.

index

The vertex index. Read-only.

marked

If the Vertex is marked or not. It is used to mark map elements that were created or changed (for example after drawing new geometry).

position

Position of the Vertex. It's an object with x and y properties. The x and y accept numbers:

v.position.x = 32;
v.position.y = 64;

It's also possible to set all fields immediately by assigning either a Vector2D, or an array of numbers:

v.position = new UDB.Vector2D(32, 64);
v.position = [ 32, 64 ];

selected

If the Vertex is selected or not.

Methods

copyPropertiesTo(v: Vertex)

Copies the properties from this Vertex to another.

Parameters

  • v: the vertex to copy the properties to

delete()

Deletes the Vertex. Note that this can result in unclosed sectors.

distanceTo(pos: object)

Gets the distance between this Vertex and the given point. The point can be either a Vector2D or an array of numbers.

v.distanceTo(new UDB.Vector2D(32, 64));
v.distanceTo([ 32, 64 ]);

Parameters

  • pos: Point to calculate the distance to.

Return value

Distance to pos

distanceToSq(pos: object)

Gets the squared distance between this Vertex and the given point. The point can be either a Vector2D or an array of numbers.

v.distanceToSq(new UDB.Vector2D(32, 64));
v.distanceToSq([ 32, 64 ]);

Parameters

  • pos: Point to calculate the squared distance to.

Return value

Squared distance to pos

getLinedefs()

Gets all Linedefs that are connected to this Vertex.

Return value

Array of linedefs

join(other: Vertex)

Joins this Vertex with another Vertex, deleting this Vertex and keeping the other.

Parameters

  • other: Vertex to join with

nearestLinedef(pos: object)

Returns the Linedef that is connected to this Vertex that is closest to the given point.

Parameters

  • pos: Point to get the nearest Linedef connected to this Vertex from

Return value

missing

snapToAccuracy()

Snaps the Vertex's position to the map format's accuracy.

snapToGrid()

Snaps the Vertex's position to the grid.