Sandbox.ModAPI
IMyPathRecorderComponent
Assembly: Sandbox.Common.dll
public interface IMyPathRecorderComponent: IMyPathRecorderComponent
Interface for modding PathRecorderComponent
Events
| Member | Description |
|---|---|
| IsPlayingChanged | Event triggered when IsPlaying changes |
| IsRecordingChanged | Event triggered when IsRecording changes |
Properties
| Member | Description |
|---|---|
| BeaconDisplayText | Gets Beacon display text Inherited from IMyPathRecorderComponent |
| BeaconEntityId | Entity of beacon in which the waypoints are in relation to Inherited from IMyPathRecorderComponent |
| BeaconWorldPosition | Gets BeaconWorldPosition Inherited from IMyPathRecorderComponent |
| IsPlaying | Gets bool if the PR block is playing Inherited from IMyPathRecorderComponent |
| IsRecording | Get bool if the PR block is recording Inherited from IMyPathRecorderComponent |
| MinimalDistance | Gets/sets minimal distance between waypoints for automatic recording to record new waypoint Inherited from IMyPathRecorderComponent |
| RecordInterval | Gets/sets record interval. Sets how often the block tries to records its position as a waypoint. Operates every 100 frames Inherited from IMyPathRecorderComponent |
| RepeatPath | Repeat path toggle Inherited from IMyPathRecorderComponent |
| ShowPath | Gets/sets if block is showing path on clients screen Inherited from IMyPathRecorderComponent |
| ShowSelectedPoints | Gets/sets if block is showing points, selected by client on his screen Inherited from IMyPathRecorderComponent |
Methods
| Member | Description |
|---|---|
| AddWaypoint(IMyAutopilotWaypoint) | Adds a waypoint unless the waypoint limit is already reached |
| DeleteAllWaypoints() | Deletes all waypoints |
| GetWaypoints(List |
Gets list of waypoints in this component |
| RemoveWaypoint(IMyAutopilotWaypoint) | Removes waypoint |
| ReverseOrder() | Reverses order of waypoints |
| Play() | Starts playing current waypoints Inherited from IMyPathRecorderComponent |
| Record() | Starts recording Inherited from IMyPathRecorderComponent |
| RemoveBeacon() | Sets BeaconEntityId = 0 Inherited from IMyPathRecorderComponent |
| StopPlay() | Stops playing current waypoints Inherited from IMyPathRecorderComponent |
| StopRecord() | Stops recording Inherited from IMyPathRecorderComponent |
Implements:
Inheritors: