TruckLib

https://sk-zk.github.io/trucklib/master/
Admin
TruckLib is a .NET library for reading and modifying map files, models, and game formats from Euro...
Tokens:165,920
Snippets:1,776
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### StartPosition Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Gets or sets the editor's starting position.

```csharp
public Vector3 StartPosition { get; set; }__
```

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

### AxisAlignedBox Start Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.AxisAlignedBox.html

Represents the start point of the axis-aligned bounding box.

```csharp
public Vector3 Start { get; set; }
```

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

### StartRotation Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Gets or sets the editor's starting rotation.

```csharp
public Quaternion StartRotation { get; set; }__
```

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

### Execute elevation retrieval in Main

Source: https://sk-zk.github.io/trucklib/master/docs/Samples/03-realroad.html

Example of calling the elevation provider from the main program entry point.

```csharp
var elevationProvider = ElevationProvider.Create();
var coordinatesWithElevation = elevationProvider.GetElevations(coordinates);
```

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

### Initialize Road Items for Connection

Source: https://sk-zk.github.io/trucklib/master/docs/TruckLib.ScsMap/polyline-items.html

Setup two road items to be merged at their respective nodes.

```csharp
Road road1 = Road.Add(map, new Vector3(10, 0, 10), new Vector3(30, 0, 10), "ger1");
Road road2 = Road.Add(map, new Vector3(32, 0, 12), new Vector3(50, 0, 30), "ger1");
```

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

### Initialize DirectoryListing

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HashFs.DirectoryListing.html

Constructor for creating a new instance of DirectoryListing with specified subdirectories and files.

```csharp
public DirectoryListing(List<string> Subdirectories, List<string> Files)__
```

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

### Quads Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.TerrainQuadData.html

Gets or sets the list of terrain quads. Indexing starts at the bottom-left corner, moving forward.

```csharp
public List<TerrainQuad> Quads { get; set; }
```

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

### Init()

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Buildings.html

Sets the item's properties to its default values.

```APIDOC
## Init()

### Description
Sets the item's properties to its default values.

### Method
protected override void Init()
```

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

### IEntry.Offset Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HashFs.IEntry.html

Gets the starting position (offset) of the file's contents within the archive. This is crucial for reading the actual file data from the archive.

```csharp
ulong Offset { get; }
```

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

### SiiFile Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Sii.SiiFile.html

Instantiates an empty SII file.

```csharp
public SiiFile()__
```

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

### Get Bit String from FlagField

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.FlagField.html

Retrieves a sub-bitstring from the FlagField, starting at a specified index and with a specified length. This method is useful for extracting specific groups of bits.

```csharp
public uint GetBitString(int start, int length)
```

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

### Instantiate PrefabNode

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.PrefabNode.html

Creates a new instance of PrefabNode with default values.

```csharp
public PrefabNode()__
```

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

### VariantOverride Offset Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.VariantOverride.html

Gets or sets the offset of the section at which the override begins, counted in the forward direction. Use this to specify the starting point of the override. One section spans three road quads.

```csharp
public ushort Offset { readonly get; set; }
```

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

### Open Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Selection.html

Reads a selection file from disk, optionally using a specific file system.

```csharp
public static Selection Open(string sbdPath)__
```

```csharp
public static Selection Open(string sbdPath, IFileSystem fs)__
```

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

### Get Equidistant Points on Spline

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HermiteSpline.html

Generates a list of oriented points spaced at a fixed interval along a Hermite spline defined by two INode objects. Offsets can be applied to the start and end of the curve.

```csharp
public static List<OrientedPoint> GetEquidistantPoints(INode n1, INode n2, float interval, float startOffset = 0, float endOffset = 0)
```

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

### Initialize KdopBounds

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.KdopBounds.html

Constructor for instantiating a new KdopBounds object.

```csharp
public KdopBounds()__
```

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

### Service Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Service.html

Initializes a new instance of the Service class.

```csharp
public Service()__
```

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

### Access Offset Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HashFs.EntryV2.html

Retrieves the starting position of the file contents in the archive.

```csharp
public readonly ulong Offset { get; }__
```

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

### VegetationPart.PartName Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.VegetationPart.html

Gets or sets the name of the part.

```csharp
public Token PartName { get; set; }
```

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

### Initialize Sector

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sector.html

Constructors for creating a new Sector instance.

```csharp
public Sector()__
```

```csharp
public Sector(int x, int z, Map map)__
```

```csharp
public Sector(SectorCoordinate coord, Map map)__
```

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

### Instantiate CompanySpawnPoint with INode and uint flags

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CompanySpawnPoint.html

Use this constructor to create a new CompanySpawnPoint instance by providing an INode and a uint flags value.

```csharp
public CompanySpawnPoint(INode node, uint flags)
```

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

### Node Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.SingleNodeItem.html

Gets or sets the node associated with the item.

```csharp
public INode Node { get; set; }__
```

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

### Nodes Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Selection.html

Gets or sets the nodes contained in the selection.

```csharp
public Dictionary<ulong, INode> Nodes { get; set; }__
```

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

### EditorMapId Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Gets or sets the editor map ID.

```csharp
public ulong EditorMapId { get; set; }__
```

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

### Instantiate Unit with Class and Name

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Sii.Unit.html

Constructs a Unit object with a specified class name and unit name. Ensure the provided strings are valid.

```csharp
public Unit(string className, string name)__
```

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

### QuadData Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.EdgeTerrain.html

Gets or sets the properties of the terrain quads.

```csharp
public TerrainQuadData QuadData { get; set; }__
```

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

### Cutscene Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Cutscene.html

Methods for adding and initializing cutscene items.

```csharp
public static Cutscene Add(IItemContainer map, Vector3 position)__
```

```csharp
protected override void Init()__
```

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

### GateActivationPoint Node Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.GateActivationPoint.html

Gets the position of the trigger for the GateActivationPoint.

```csharp
public readonly INode Node { get; }
```

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

### Init Method

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.EdgeTerrain.html

Sets the RoadTerrain's properties to their default values. This is a protected virtual method.

```csharp
protected virtual void Init()__
```

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

### Map Opening

Source: https://sk-zk.github.io/trucklib/master/docs/TruckLib.ScsMap/map-class.html

Shows how to load an existing map from disk, with options for specific sectors or from an SCS file.

```APIDOC
## Opening a Map

### Description
To load an existing map from disk, call the static `Map.Open` method with the path of the `.mbd` file. An optional `sectors` parameter can be used to load specific sectors. An additional overload allows loading a map directly from a .scs file using an `IHashFsReader`.

### Method
Static `Map.Open`

### Endpoint
N/A

### Parameters
#### Path Parameters
- **path** (string) - Required - The path to the `.mbd` file.
- **sectors** (list or array of sector coordinates) - Optional - Specifies which sectors to load.
- **reader** (IHashFsReader) - Required for SCS file loading - An instance of `IHashFsReader`.

### Request Example
```csharp
// Loading a map from a .mbd file
using TruckLib.ScsMap;

Map map = Map.Open(@"E:\SteamLibrary\steamapps\common\Euro Truck Simulator 2\extracted\map\europe.mbd");

// Loading a map with specific sectors
// Map map = Map.Open(@"path/to/map.mbd", new List<string> { "sector_01", "sector_02" });

// Loading a map directly from a .scs file
using TruckLib.HashFs;
using TruckLib.ScsMap;

IHashFsReader reader = HashFsReader.Open("base_map.scs");
Map map = Map.Open("/map/europe.mbd", reader);
```

### Response Example
N/A
```

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

### Get CurveLocatorList Enumerator

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Collections.CurveLocatorList.html

Returns an enumerator that iterates through the CurveLocatorList.

```csharp
public IEnumerator<INode> GetEnumerator()
```

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

### TargetRange Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.ActionBase.html

Gets or sets the target range for the action.

```csharp
public float TargetRange { get; set; }__
```

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

### Manage Gate Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Gate.html

Methods for adding gates to the map and initializing default properties.

```csharp
public static Gate Add(IItemContainer map, Vector3 position, Token model, GateType type)__
```

```csharp
protected override void Init()__
```

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

### Call Projection Function

Source: https://sk-zk.github.io/trucklib/master/docs/Samples/03-realroad.html

Example of calling the Project function with WGS1984 as the source and WGS1984UTMZone32N as the destination.

```csharp
var sourceCrs = KnownCoordinateSystems.Geographic.World.WGS1984;
var destCrs = KnownCoordinateSystems.Projected.UtmWgs1984.WGS1984UTMZone32N;
var points = Project(coordinatesWithElevation, sourceCrs, destCrs);
```

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

### Rows Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.TerrainQuadData.html

Gets or sets the amount of rows in the terrain quad.

```csharp
public ushort Rows { get; set; }
```

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

### Stage files for HashFS archive

Source: https://sk-zk.github.io/trucklib/master/docs/TruckLib.HashFs/writer.html

Use the Add method to stage files for packing into a HashFS archive. The first parameter is the file path or stream, and the second is the archive path. Throws ArgumentException for invalid archive paths.

```csharp
using TruckLib.HashFs;

HashFsV2Writer writer = new();
writer.Add(@"D:\foo\bar\manifest.sii", "/manifest.sii");
writer.Add(@"C:\stuff\my_house.pmd", "/model/building/my_house.pmd");
```

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

### Sound Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sound.html

Initializes a new instance of the Sound class. This is the default constructor.

```csharp
public Sound()__
```

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

### Cols Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.TerrainQuadData.html

Gets or sets the amount of columns in the terrain quad.

```csharp
public ushort Cols { get; set; }
```

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

### Token Constructors

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Token.html

Provides information on how to create new Token instances.

```APIDOC
## Token(string)

### Description
Creates a new token from a string.

### Parameters
- **str** (string) - The string representation of the token.

## Token(ulong)

### Description
Creates a new token from an unsigned long integer.

### Parameters
- **token** (ulong) - The integer representation of the token.
```

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

### VegetationPart.Vegetation Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.VegetationPart.html

Gets or sets the vegetation data associated with the part.

```csharp
public Vegetation[] Vegetation { get; set; }
```

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

### PrefabTerrain Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.PrefabTerrain.html

Documentation for the methods available in the PrefabTerrain class.

```APIDOC
## Method CalculateQuadGrid()

### Description
Updates the amount of quad columns and rows of this terrain.

```csharp
public void CalculateQuadGrid()
```

## Method Init()

### Description
Sets the PrefabTerrain's properties to its default values.

```csharp
protected override void Init()
```
```

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

### Vegetation Scale Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Vegetation.html

Gets or sets the scale of the vegetation models.

```csharp
public VegetationScale Scale { get; set; }__
```

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

### Vegetation Density Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Vegetation.html

Gets or sets the density of the vegetation models.

```csharp
public float Density { get; set; }__
```

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

### Map Creation

Source: https://sk-zk.github.io/trucklib/master/docs/TruckLib.ScsMap/map-class.html

Demonstrates how to create a new, empty map object.

```APIDOC
## Creating a Map

### Description
To create a new, empty map, call the constructor of `Map`.

### Method
Constructor

### Endpoint
N/A

### Request Example
```csharp
using TruckLib.ScsMap;

Map map = new Map();
```

### Response Example
N/A
```

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

### Load Prefab Descriptor from File

Source: https://sk-zk.github.io/trucklib/master/docs/TruckLib.ScsMap/prefabs.html

Loads a prefab descriptor from a .ppd file. Ensure the file path is correct.

```csharp
using TruckLib.Models.Ppd;

PrefabDescriptor ppd = PrefabDescriptor.Open("<location of extracted files>/prefab2/car_dealer/car_dealer_01_fr.ppd");

```

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

### MapItems Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Selection.html

Gets or sets the map items contained in the selection.

```csharp
public Dictionary<ulong, MapItem> MapItems { get; set; }__
```

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

### EnvironmentArea Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.EnvironmentArea.html

Methods for adding and initializing environment areas.

```csharp
public static EnvironmentArea Add(IItemContainer map, Vector3 position, float width, float height)__
```

```csharp
protected override void Init()__
```

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

### Access Sidewalk Size

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sidewalk.html

Gets or sets the size configuration for the sidewalk.

```csharp
public SidewalkSize Size { get; set; }__
```

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

### Instantiate Empty Unit

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Sii.Unit.html

Constructs an empty Unit object. No specific setup is required beyond this constructor.

```csharp
public Unit()__
```

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

### Instantiate CompanySpawnPoint with INode and CompanySpawnPointType

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CompanySpawnPoint.html

Use this constructor to create a new CompanySpawnPoint instance by providing an INode and a CompanySpawnPointType.

```csharp
public CompanySpawnPoint(INode node, CompanySpawnPointType type)
```

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

### Nodes Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Gets a dictionary containing the map's nodes.

```csharp
public NodeDictionary Nodes { get; }__
```

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

### Access Railing Models

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Railings.html

Gets or sets the collection of railing models.

```csharp
public Railing[] Models { get; set; }__
```

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

### PrefabSlaveItem Class Overview

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.PrefabSlaveItem.html

Provides an overview of the PrefabSlaveItem class, its inheritance, and implemented interfaces.

```APIDOC
## Class PrefabSlaveItem

### Namespace
    TruckLib.ScsMap 

### Assembly
    TruckLib.dll

### Description
Base class for prefab slave items, which is a type of item that is placed for certain spawn point types of a prefab.

```csharp
public abstract class PrefabSlaveItem : SingleNodeItem, IMapItem, IMapObject
```

### Inheritance
    object
    MapItem
    SingleNodeItem
    PrefabSlaveItem 

### Implements
    IMapItem
    IMapObject 

### Derived Classes
    BusStop
    Company
    Garage
    Service 
```

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

### Material Name Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Material.html

Gets or sets the token name of the material.

```csharp
public Token Name { readonly get; set; }__
```

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

### Sector Class Constructors

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sector.html

Details on how to instantiate a Sector object.

```APIDOC
## Sector()

### Description
Instantiates a sector with default metadata.

### Method
GET

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **Sector** (object) - A new Sector object.

#### Response Example
```json
{
  "message": "Sector object created successfully"
}
```

## Sector(int, int, Map)

### Description
Instantiates a sector with default metadata using X and Z coordinates and a Map object.

### Method
GET

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Sector** (object) - A new Sector object initialized with coordinates and map.

#### Response Example
```json
{
  "message": "Sector object created successfully with coordinates and map"
}
```

## Sector(SectorCoordinate, Map)

### Description
Instantiates a sector with default metadata using a SectorCoordinate object and a Map object.

### Method
GET

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Sector** (object) - A new Sector object initialized with SectorCoordinate and map.

#### Response Example
```json
{
  "message": "Sector object created successfully with SectorCoordinate and map"
}
```
```

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

### Parent Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Collections.GateActivationPointList.html

Gets the parent Gate item associated with these models.

```csharp
public Gate Parent { get; init; }__
```

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

### Sign Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sign.html

Methods for adding signs to the map and initializing default properties.

```csharp
public static Sign Add(IItemContainer map, Vector3 position, Token model)__
```

```csharp
public static Sign Add(IItemContainer map, Vector3 position, Token model, string template)__
```

```csharp
protected override void Init()__
```

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

### CurveLocatorList Count Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Collections.CurveLocatorList.html

Gets the current number of elements in the CurveLocatorList.

```csharp
public int Count { get; }
```

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

### CityArea Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CityArea.html

Methods for managing and initializing city area instances.

```csharp
public static CityArea Add(IItemContainer map, Vector3 position, Token name, float width, float height)
```

```csharp
protected override void Init()
```

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

### Node Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Node.html

Instantiates a new node with a random UID. No specific setup is required before calling this constructor.

```csharp
public Node()__
```

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

### Buildings.DlcGuard Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Buildings.html

Gets or sets the DLC guard value for the building.

```csharp
public byte DlcGuard { get; set; }__
```

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

### CameraPoint.Init Method

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CameraPoint.html

Sets the item's properties to their default values. This method is protected and overridden from the base class.

```csharp
protected override void Init()
```

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

### VegetationPart Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.VegetationPart.html

Initializes a new instance of the VegetationPart class.

```csharp
public VegetationPart()
```

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

### CompanySpawnPoint Type Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CompanySpawnPoint.html

Gets or sets the type of the spawn point.

```csharp
public CompanySpawnPointType Type { get; set; }
```

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

### Tobj Type Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the type of the texture for the Tobj.

```csharp
public TobjType Type { get; set; }__
```

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

### Prefab Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Prefab.html

Initializes a new instance of the Prefab class.

```csharp
public Prefab()__
```

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

### Tobj MipFilter Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the mipmap filter for the Tobj.

```csharp
public TobjMipFilter MipFilter { get; set; }__
```

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

### Initialize FarModelData

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.FarModelData.html

Constructor for FarModelData. Requires an INode, a Token for the model, and a Vector3 for the scale.

```csharp
public FarModelData(INode node, Token model, Vector3 scale)__
```

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

### Hookup Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Hookup.html

Initializes a new instance of the Hookup class.

```csharp
public Hookup()__
```

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

### StringParams Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.ActionBase.html

Gets or sets a list of string parameters for the action.

```csharp
public List<string> StringParams { get; set; }__
```

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

### Tobj MinFilter Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the minification filter for the Tobj.

```csharp
public TobjFilter MinFilter { get; set; }__
```

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

### SiiFile Class Overview

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Sii.SiiFile.html

Provides an overview of the SiiFile class, its namespace, and assembly.

```APIDOC
## Class SiiFile

Namespace
    TruckLib.Sii 

Assembly
    TruckLib.Sii.dll

Represents a SII file.
```csharp
public class SiiFile
```
```

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

### UnsupportedVersionException Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.UnsupportedVersionException.html

Constructor for initializing the exception with a descriptive error message.

```csharp
public UnsupportedVersionException(string message)__
```

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

### NumParams Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.ActionBase.html

Gets or sets a list of float parameters for the action.

```csharp
public List<float> NumParams { get; set; }__
```

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

### Tobj MagFilter Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the magnification filter for the Tobj.

```csharp
public TobjFilter MagFilter { get; set; }__
```

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

### Initialize Garage

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Garage.html

Constructor for the Garage class.

```csharp
public Garage()__
```

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

### Open HashFS archive from path

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HashFs.HashFsReader.html

Opens a HashFS archive using a file path string.

```csharp
public static IHashFsReader Open(string path)__
```

```csharp
public static IHashFsReader Open(string path, bool forceEntryTableAtEnd)__
```

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

### OrientedPoint Rotation Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.OrientedPoint.html

Gets or sets the rotation component of the OrientedPoint.

```csharp
public Quaternion Rotation { readonly get; set; }
```

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

### AssetLoader Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HashFs.AssetLoader.html

Instantiates a new AssetLoader with a specified array of IFileSystems. The order of the array determines the query priority.

```APIDOC
## AssetLoader(IFileSystem[])

### Description
Instantiates a new AssetLoader.

### Parameters
#### Path Parameters
- **fileSystems** (IFileSystem[]) - Required - The IFileSystems to wrap. The order of this array determines the order in which the file systems will be queried.

### Exceptions
- **ArgumentNullException** - Thrown if the given array is null or empty.
```

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

### TerrainPoint Position Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Ppd.TerrainPoint.html

Gets or sets the position of the terrain point.

```csharp
public Vector3 Position { readonly get; set; }
```

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

### IHashFsReader Version Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HashFs.IHashFsReader.html

Gets the version of the HashFS archive format.

```csharp
ushort Version { get; }
```

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

### Initialize Placement Struct

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Sii.Placement.html

Constructor for creating a new Placement instance with a specified position and rotation.

```csharp
public Placement(Vector3 position, Quaternion rotation)__
```

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

### CopyTo Method

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Collections.GateActivationPointList.html

Copies collection elements to an array starting at a specified index.

```csharp
public void CopyTo(GateActivationPoint[] array, int arrayIndex)__
```

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

### Instantiate a new map

Source: https://sk-zk.github.io/trucklib/master/docs/Samples/01-simple.html

Initialize an empty map object to begin adding items.

```csharp
using TruckLib.ScsMap;

var map = new Map();
```

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

### MapOverlay.Init Method

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.MapOverlay.html

Sets the item's properties to its default values.

```APIDOC
### Init()

Sets the item's properties to its default values.

```csharp
protected override void Init()
```
```

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

### Sound.Type Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sound.html

Gets or sets the type of the sound. The value is of type SoundType.

```csharp
public SoundType Type { get; set; }
```

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

### Service Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Service.html

Methods for adding, initializing, moving, and translating Service items.

```csharp
public static Service Add(IItemContainer map, Prefab parent, Vector3 position)
```

```csharp
protected override void Init()
```

```csharp
public override void Move(Vector3 newPos)
```

```csharp
public override void Translate(Vector3 translation)
```

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

### Create and Save a Selection

Source: https://sk-zk.github.io/trucklib/master/docs/TruckLib.ScsMap/selection-class.html

Demonstrates how to create a new Selection, add a model to it, and save it to a .sbd file. Requires TruckLib.ScsMap and System.Numerics namespaces.

```csharp
using System.Numerics;
using TruckLib.ScsMap;

Selection selection = new();
Model model = Model.Add(selection, new Vector3(10f, 0f, 10f), 
    "dlc_no_471", "brick", "default"
);
selection.Save("example.sbd");
```

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

### Access Sidewalk Material

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sidewalk.html

Gets or sets the unit name of the sidewalk material.

```csharp
public Token Material { get; set; }__
```

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

### Access Z coordinate

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.SectorCoordinate.html

Property to get or set the Z coordinate value.

```csharp
public int Z { readonly get; set; }__
```

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

### Import Method

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Imports the contents of a Selection (.sbd) file into the current map at the specified position.

```csharp
public void Import(Selection selection, Vector3 position)__
```

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

### Access X coordinate

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.SectorCoordinate.html

Property to get or set the X coordinate value.

```csharp
public int X { readonly get; set; }__
```

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

### Initialize VisibilityArea

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.VisibilityArea.html

Constructor for the VisibilityArea class.

```csharp
public VisibilityArea()__
```

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

### IFileSystem Interface Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.IFileSystem.html

Methods for interacting with the file system, including checking existence, listing files, and reading content.

```APIDOC
## DirectoryExists(string)

### Description
Determines whether the given path refers to an existing directory.

### Parameters
- **path** (string) - Required - The directory to check.

### Response
- **Returns** (bool) - true if path refers to an existing directory; false otherwise.

## FileExists(string)

### Description
Determines whether the specified file exists.

### Parameters
- **path** (string) - Required - The file to check.

### Response
- **Returns** (bool) - true if the file exists; otherwise, false.

## GetFiles(string)

### Description
Returns the names of files (including their paths) in the specified directory.

### Parameters
- **path** (string) - Required - The absolute path to the directory to search.

### Response
- **Returns** (IList<string>) - An array of the full names for the files in the specified directory.

## GetParent(string)

### Description
Retrieves the parent directory of the specified path.

### Parameters
- **path** (string) - Required - The path for which to retrieve the parent directory.

### Response
- **Returns** (string) - The parent directory, or null if path is the root directory.

## Open(string)

### Description
Opens a stream on the specified path.

### Parameters
- **path** (string) - Required - The file to open.

### Response
- **Returns** (Stream) - A stream for reading the file.

## ReadAllBytes(string)

### Description
Opens a binary file, reads the contents of the file into a byte array, and then closes the file.

### Parameters
- **path** (string) - Required - The file to open for reading.

### Response
- **Returns** (byte[]) - A byte array containing the contents of the file.

## ReadAllText(string, Encoding)

### Description
Opens a text file, reads all the text in the file into a string, and then closes the file.

### Parameters
- **path** (string) - Required - The file to open for reading.
- **encoding** (Encoding) - Optional - The encoding applied to the contents of the file.

### Response
- **Returns** (string) - A string containing all the text in the file.
```

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

### NormalScale Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Gets or sets the scale and time compression outside of cities.

```csharp
public float NormalScale { get; set; }__
```

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

### PrefabSlaveItem Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.PrefabSlaveItem.html

Details the methods available for PrefabSlaveItem objects, including adding, moving, and updating items.

```APIDOC
## Methods

### Add<T>(IItemContainer, Prefab, Vector3)
Adds a new prefab slave item of type T to the map.

```csharp
public static T Add<T>(IItemContainer map, Prefab parent, Vector3 position) where T : PrefabSlaveItem, new()
```

#### Parameters
- `map` (IItemContainer) - Required - The map.
- `parent` (Prefab) - Required - The prefab this item is linked to.
- `position` (Vector3) - Required - The (global) position of the node.

#### Returns
`T` - The newly created prefab slave item.

#### Type Parameters
- `T` - The item type.

### Init()
Sets the item's properties to its default values.

```csharp
protected override void Init()
```

### Move(Vector3)
Moves the item to a different location.

```csharp
public override void Move(Vector3 newPos)
```

#### Parameters
- `newPos` (Vector3) - Required - The new position.

### Translate(Vector3)
Translates the item by the given vector.

```csharp
public override void Translate(Vector3 translation)
```

#### Parameters
- `translation` (Vector3) - Required - The translation vector.

### UpdateItemReferences(Dictionary<ulong, MapItem>)
Searches a list of all map items for the map items referenced by UID in this map item and updates the respective references. This is used for loading a map and does not need to be called by the user at any point.

```csharp
public void UpdateItemReferences(Dictionary<ulong, MapItem> allItems)
```

#### Parameters
- `allItems` (Dictionary<ulong, MapItem>) - Required - A dictionary of all items in the entire map.
```

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

### CityScale Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Gets or sets the scale and time compression within cities.

```csharp
public float CityScale { get; set; }__
```

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

### Material Rotation Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Material.html

Gets or sets the UV rotation of the material in degrees.

```csharp
public float Rotation { readonly get; set; }__
```

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

### Hookup Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Hookup.html

Methods for adding a hookup to the map and initializing default values.

```csharp
public static Hookup Add(IItemContainer map, Vector3 position, string name)__
```

```csharp
protected override void Init()__
```

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

### Coefficient Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.EdgeTerrain.html

Gets or sets the vertical scale coefficient for the terrain profile.

```csharp
public float Coefficient { get; set; }__
```

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

### Initialize Part constructors

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Part.html

Constructors for creating a new instance of the Part class.

```csharp
public Part()__
```

```csharp
public Part(Token name)__
```

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

### GateActivationPoint Trigger Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.GateActivationPoint.html

Gets or sets the name of the trigger type for the GateActivationPoint.

```csharp
public string Trigger { readonly get; set; }
```

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

### Tobj Open from file path

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Opens and loads a Tobj from a specified file path. This is a static method.

```csharp
public static Tobj Open(string tobjPath)__
```

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

### Initialize TruckLib Map

Source: https://sk-zk.github.io/trucklib/master/docs/Samples/03-realroad.html

Creates a new TruckLib map instance and sets its normal and city scales. Requires TruckLib.ScsMap namespace.

```csharp
using TruckLib.ScsMap;

var map = new Map();
map.NormalScale = 1;
map.CityScale = 1;
```

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

### Buildings.ViewDistance Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Buildings.html

Gets or sets the view distance for the building item in meters.

```csharp
public ushort ViewDistance { get; set; }__
```

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

### Buildings.Look Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Buildings.html

Gets or sets the visual appearance (look) of the building model.

```csharp
public Token Look { get; set; }__
```

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

### Sign Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sign.html

Initializes a new instance of the Sign class.

```csharp
public Sign()__
```

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

### CompanySpawnPoint TrailerType Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CompanySpawnPoint.html

Gets or sets the type of the trailer for the spawn point.

```csharp
public CompanySpawnPointTrailerType TrailerType { get; set; }
```

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

### Extract Game Assets using HashFsReader

Source: https://sk-zk.github.io/trucklib/master/docs/Samples/02-prefabs.html

Opens the base.scs archive to extract prefab descriptors. Ensure the gameRoot path is correctly set for your installation.

```csharp
using TruckLib.HashFs;

// (modify this path before running)
var gameRoot = @"E:\SteamLibrary\steamapps\common\Euro Truck Simulator 2";
var baseScs = HashFsReader.Open(Path.Combine(gameRoot, "base.scs"));
```

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

### CompanySpawnPoint Node Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CompanySpawnPoint.html

Gets or sets the INode associated with the spawn point.

```csharp
public INode Node { get; set; }
```

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

### Instantiate AssetLoader

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HashFs.AssetLoader.html

Use this constructor to create a new AssetLoader instance. The order of file systems in the array determines the priority of access.

```csharp
public AssetLoader(IFileSystem[] fileSystems)
```

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

### ActionBase Class Overview

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.ActionBase.html

Provides an overview of the ActionBase class, its inheritance, and implemented interfaces.

```APIDOC
## Class ActionBase

### Namespace
TruckLib.ScsMap

### Assembly
TruckLib.dll

### Description
Base class for CutsceneAction and TriggerAction.

```csharp
public abstract class ActionBase : IBinarySerializable
```

### Inheritance
- object
- ActionBase

### Implements
- IBinarySerializable

### Derived Classes
- CutsceneAction
- TriggerAction

### Inherited Members
- object.Equals(object)
- object.Equals(object, object)
- object.GetHashCode()
- object.GetType()
- object.MemberwiseClone()
- object.ReferenceEquals(object, object)
- object.ToString()
```

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

### Tobj TexturePath Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the file path to the texture for the Tobj.

```csharp
public string TexturePath { get; set; }__
```

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

### Save Method

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Selection.html

Saves the current selection to a file in binary format.

```csharp
public void Save(string sbdPath)__
```

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

### Tobj ColorSpace Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the color space of the texture for the Tobj.

```csharp
public TobjColorSpace ColorSpace { get; set; }__
```

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

### CameraPath Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CameraPath.html

Initializes a new instance of the CameraPath class.

```csharp
public CameraPath()__
```

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

### Tobj AddrW Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the W-axis texture address for the Tobj.

```csharp
public TobjAddr AddrW { get; set; }__
```

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

### Buildings Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Buildings.html

Initializes a new instance of the Buildings class.

```csharp
public Buildings()__
```

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

### Tobj AddrV Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the V-axis texture address for the Tobj.

```csharp
public TobjAddr AddrV { get; set; }__
```

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

### Tobj AddrU Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Tobj.html

Gets or sets the U-axis texture address for the Tobj.

```csharp
public TobjAddr AddrU { get; set; }__
```

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

### PrefabSlaveItem Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.PrefabSlaveItem.html

Initializes a new instance of the PrefabSlaveItem class. This is a protected constructor.

```csharp
public PrefabSlaveItem()__
```

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

### TerrainPoint Normal Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Models.Ppd.TerrainPoint.html

Gets or sets the normal vector of the terrain point.

```csharp
public Vector3 Normal { readonly get; set; }
```

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

### IHashFsReader BaseReader Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.HashFs.IHashFsReader.html

Gets the BinaryReader instance used by the HashFS reader.

```csharp
BinaryReader BaseReader { get; }
```

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

### Sound Class Overview

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sound.html

Provides an overview of the Sound class, its inheritance, and implemented interfaces.

```APIDOC
## Class Sound

Namespace
    TruckLib.ScsMap 

Assembly
    TruckLib.dll

A sound which is played when the player is in range.
```
public class Sound : SingleNodeItem, IMapItem, IMapObject
```

Inheritance
    
object
MapItem
SingleNodeItem
Sound 

Implements
    
IMapItem
IMapObject
```

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

### Initialize MapArea

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.MapArea.html

Constructor for the MapArea class.

```csharp
public MapArea()__
```

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

### CopyTo CompanySpawnPointList Method

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Collections.CompanySpawnPointList.html

Copies the elements of the CompanySpawnPointList to an array, starting at a specified index.

```csharp
public void CopyTo(CompanySpawnPoint[] array, int arrayIndex)__
```

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

### Normals Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.TerrainQuadData.html

Gets or sets the vertex data for normals. TODO: Clarify purpose.

```csharp
public List<VertexData> Normals { get; set; }
```

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

### Map Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Details on how to create an empty map instance.

```APIDOC
## Constructors

### Map()

Creates an empty map.
```

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

### BrushMaterials Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.TerrainQuadData.html

Gets or sets the list of materials used for painting terrain quads.

```csharp
public List<Material> BrushMaterials { get; set; }
```

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

### SiiFile Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.Sii.SiiFile.html

Details the various methods available for interacting with SiiFile objects.

```APIDOC
## Methods

### Decode(byte[])

Decodes a 3nK-encoded or encrypted SII file to its regular text form.

```csharp
public static byte[] Decode(byte[] sii)
```

#### Parameters 

`sii` byte[]
    
The SII file to decode.
#### Returns 

byte[]
    
The decoded SII file. If the input was already in text form or is unsupported, it is returned unchanged.

### Load(byte[], string)

Deserializes a SII file.

```csharp
public static SiiFile Load(byte[] sii, string siiDirectory = "")
```

#### Parameters 

`sii` byte[]
    
The buffer containing the SII file.

`siiDirectory` string
    
The path of the directory in which the SII file is located. Required for inserting `@include`s. Can be omitted if the file is known not to have `@include`s.
#### Returns 

SiiFile
    
A SiiFile object.

### Load(byte[], string, IFileSystem)

Deserializes a SII file.

```csharp
public static SiiFile Load(byte[] sii, string siiDirectory, IFileSystem fs)
```

#### Parameters 

`sii` byte[]
    
The buffer containing the SII file.

`siiDirectory` string
    
The path of the directory in which the SII file is located. Required for inserting `@include`s. Can be omitted if the file is known not to have `@include`s.

`fs` IFileSystem
    
The file system to load `@include`d files from.
#### Returns 

SiiFile
    
A SiiFile object.

### Load(byte[], string, IFileSystem, bool)

Deserializes a SII file.

```csharp
public static SiiFile Load(byte[] sii, string siiDirectory, IFileSystem fs, bool ignoreMissingIncludes)
```

#### Parameters 

`sii` byte[]
    
The buffer containing the SII file.

`siiDirectory` string
    
The path of the directory in which the SII file is located. Required for inserting `@include`s. Can be omitted if the file is known not to have `@include`s.

`fs` IFileSystem
    
The file system to load `@include`d files from.

`ignoreMissingIncludes` bool
    
If true, missing `@include`d files are ignored. If false, an exception will be thrown.
#### Returns 

SiiFile
    
A SiiFile object.

### Load(string, string)

Deserializes a SII file.

```csharp
public static SiiFile Load(string sii, string siiDirectory = "")
```

#### Parameters 

`sii` string
    
The string containing the SII file.

`siiDirectory` string
    
The path of the directory in which the SII file is located. Required for inserting `@include`s. Can be omitted if the file is known not to have `@include`s.
#### Returns 

SiiFile
    
A SiiFile object.

### Load(string, string, IFileSystem)

Deserializes a SII file.

```csharp
public static SiiFile Load(string sii, string siiDirectory, IFileSystem fs)
```

#### Parameters 

`sii` string
    
The string containing the SII file.

`siiDirectory` string
    
The path of the directory in which the SII file is located. Required for inserting `@include`s. Can be omitted if the file is known not to have `@include`s.

`fs` IFileSystem
    
The file system to load `@include`d files from.
#### Returns 

SiiFile
    
A SiiFile object.

### Load(string, string, IFileSystem, bool)

Deserializes a SII file.

```csharp
public static SiiFile Load(string sii, string siiDirectory, IFileSystem fs, bool ignoreMissingIncludes)
```

#### Parameters 

`sii` string
    
The string containing the SII file.

`siiDirectory` string
    
The path of the directory in which the SII file is located. Required for inserting `@include`s. Can be omitted if the file is known not to have `@include`s.

`fs` IFileSystem
    
The file system to load `@include`d files from.

`ignoreMissingIncludes` bool
    
If true, missing `@include`d files are ignored. If false, an exception will be thrown.
#### Returns 

SiiFile
    
A SiiFile object.

### Open(string)

Opens a SII file.

```csharp
public static SiiFile Open(string path)
```

#### Parameters 

`path` string
    
The path of the file.
#### Returns 

SiiFile
    
A SiiFile object.

### Open(string, IFileSystem)

Opens a SII file.

```csharp
public static SiiFile Open(string path, IFileSystem fs)
```

#### Parameters 

`path` string
    
The path of the file.

`fs` IFileSystem
    
The file system to load this file and `@include`d files from.
#### Returns 

SiiFile
    
A SiiFile object.
```

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

### BrushColors Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.TerrainQuadData.html

Gets or sets the list of colors used for painting terrain quads.

```csharp
public List<Color> BrushColors { get; set; }
```

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

### FarModel Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.FarModel.html

Initializes a new instance of the FarModel class.

```csharp
public FarModel()__
```

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

### Sidewalk Methods

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Sidewalk.html

Details the methods available for the Sidewalk class, specifically the Clone method.

```APIDOC
## Methods

### Clone()

Makes a deep copy of this object.

```csharp
public Sidewalk Clone()
```

#### Returns 

Sidewalk
    
A deep copy of this object.
```

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

### Get NodeDictionary Keys

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Collections.NodeDictionary.html

Retrieves a collection of all keys present in the NodeDictionary. This property is read-only.

```csharp
public ICollection<ulong> Keys { get; }
```

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

### Open an existing map

Source: https://sk-zk.github.io/trucklib/master/docs/TruckLib.ScsMap/map-class.html

Load a map from a file path or an IHashFsReader instance.

```csharp
using TruckLib.ScsMap;

Map map = Map.Open(@"E:\SteamLibrary\steamapps\common\Euro Truck Simulator 2\extracted\map\europe.mbd");
```

```csharp
using TruckLib.HashFs;
using TruckLib.ScsMap;

IHashFsReader reader = HashFsReader.Open("base_map.scs");
Map map = Map.Open("/map/europe.mbd", reader);
```

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

### Access Value Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.SignOverrideAttribute-1.html

Gets or sets the value that overrides the default template value.

```csharp
public T Value { get; set; }__
```

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

### Sectors Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Gets or sets a dictionary containing metadata for the map's sectors.

```csharp
public Dictionary<SectorCoordinate, Sector> Sectors { get; set; }__
```

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

### Map Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Map.html

Creates an empty map instance.

```csharp
public Map()
```

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

### CompanySpawnPointList Constructor

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Collections.CompanySpawnPointList.html

Instantiates an empty CompanySpawnPointList, requiring a parent Company object.

```csharp
public CompanySpawnPointList(Company parent)__
```

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

### MapItem.ItemFile Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.MapItem.html

Gets which sector file the item is written to. This is a virtual property that can be overridden.

```csharp
public virtual ItemFile ItemFile { get; }
```

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

### Access PathItem nodes

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.PathItem.html

Property to get or set the collection of nodes associated with the item.

```csharp
public PathNodeList Nodes { get; set; }__
```

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

### Initialize CutPlane

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.CutPlane.html

Constructor for creating a new instance of a CutPlane.

```csharp
public CutPlane()__
```

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

### Initialize Gate

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Gate.html

Constructor for creating a new instance of a Gate.

```csharp
public Gate()__
```

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

### Access Minimums Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.KdopBounds.html

Gets or sets the minimum values of the k-DOP bounding box.

```csharp
public float[] Minimums { get; set; }__
```

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

### Initialize PathItem

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.PathItem.html

Protected constructor for the abstract PathItem class.

```csharp
protected PathItem()__
```

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

### Access Maximums Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.KdopBounds.html

Gets or sets the maximum values of the k-DOP bounding box.

```csharp
public float[] Maximums { get; set; }__
```

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

### BezierPatch VegetationSpheres Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.BezierPatch.html

Gets or sets the vegetation spheres defined on this Bézier patch.

```csharp
public List<VegetationSphere> VegetationSpheres { get; set; }
```

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

### BezierPatch QuadData Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.BezierPatch.html

Gets or sets the terrain quad data for this Bézier patch.

```csharp
public TerrainQuadData QuadData { get; set; }
```

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

### Initialize Railings

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Railings.html

Constructor for the Railings class.

```csharp
public Railings()__
```

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

### CurveLocatorList Parent Property

Source: https://sk-zk.github.io/trucklib/master/api/TruckLib.ScsMap.Collections.CurveLocatorList.html

Gets the parent Curve item associated with this list of nodes.

```csharp
public Curve Parent { get; init; }
```
Tokens:
Raw