Sandbox.ModAPI.Ingame.IMyPathRecorderComponent

← Index ← Namespace Index

IMyPathRecorderComponent Interface

public interface IMyPathRecorderComponent

Ingame interfave for PB and mods

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll

Properties

string BeaconDisplayText { get; }

Gets Beacon display text

long? BeaconEntityId { get; }

Entity of beacon in which the waypoints are in relation to

Vector3D BeaconWorldPosition { get; }

Gets BeaconWorldPosition

bool IsPlaying { get; }

Gets bool if the PR block is playing

bool IsRecording { get; }

Get bool if the PR block is recording

float MinimalDistance { get; set; }

Gets/sets minimal distance between waypoints for automatic recording to record new waypoint

byte RecordInterval { get; set; }

Gets/sets record interval. Sets how often the block tries to records its position as a waypoint. Operates every 100 frames

bool RepeatPath { get; set; }

Repeat path toggle

bool ShowPath { get; set; }

Gets/sets if block is showing path on clients screen

bool ShowSelectedPoints { get; set; }

Gets/sets if block is showing points, selected by client on his screen

Methods

void Play()

Starts playing current waypoints

void Record()

Starts recording

void RemoveBeacon()

Sets BeaconEntityId = 0

void StopPlay()

Stops playing current waypoints

void StopRecord()

Stops recording