Table of Contents

Interface IXPlatformInterface

Namespace
Vintagestory.API.Common
Assembly
VintagestoryAPI.dll

The platform interface for various controls. Used by the game to handle various properties.

public interface IXPlatformInterface
Extension Methods

Properties

Window

GameWindow Window { get; set; }

Property Value

GameWindow

Methods

AvailableCodecs()

AvailableCodec[] AvailableCodecs()

Returns

AvailableCodec[]

FocusWindow()

void FocusWindow()

GetAviWriter(int, double, string)

IAviWriter GetAviWriter(int recordingBufferSize, double framerate, string codeccode)

Parameters

recordingBufferSize int
framerate double
codeccode string

Returns

IAviWriter

GetClipboardText()

string GetClipboardText()

Returns

string

GetFreeDiskSpace(string)

Total disk space in bytes

long GetFreeDiskSpace(string filepath)

Parameters

filepath string

Returns

long

GetRamCapacity()

Total system ram in bytes

long GetRamCapacity()

Returns

long

GetScreenSize()

Size2i GetScreenSize()

Returns

Size2i

MoveFileToRecyclebin(string)

void MoveFileToRecyclebin(string filepath)

Parameters

filepath string

SetClipboardText(string)

void SetClipboardText(string text)

Parameters

text string

ShowMessageBox(string, string)

void ShowMessageBox(string title, string text)

Parameters

title string
text string