S9SourceNine Labs / CMAPI Docs 1.1
CMAPI / API reference

InventorySafetyReport

Reports whether loaded inventories can be opened safely without virtualization.

View source ↗
CMAPI 1.1.4Standalone runtimeWindows x64Tested with Planet Crafter 2.008
Namespace CMAPIClassAssembly CMAPI.API.dll
public sealed class InventorySafetyReport

Reports whether loaded inventories can be opened safely without virtualization.

Members

InventoriesCheckedGets the number of loaded inventories inspected.propertyIssuesGets every loaded inventory which exceeds native capacity.propertyIsVanillaSafeGets whether all loaded inventories remain within native capacity.propertyInventorySafetyReportCreates an immutable inventory safety report.method

InventoriesChecked

property
public int InventoriesChecked

Gets the number of loaded inventories inspected.

Issues

property
public IReadOnlyList<InventorySafetyIssue> Issues

Gets every loaded inventory which exceeds native capacity.

IsVanillaSafe

property
public bool IsVanillaSafe => Issues.Count == 0

Gets whether all loaded inventories remain within native capacity.

InventorySafetyReport

method
public InventorySafetyReport( int inventoriesChecked, InventorySafetyIssue[] issues)

Creates an immutable inventory safety report.