Sandbox.ModAPI.Ingame
IMyPathRecorderComponent
Assembly: Sandbox.Common.dll
public interface IMyPathRecorderComponent
Ingame interfave for PB and mods
Properties
| Member | Description |
|---|---|
| BeaconDisplayText | Gets Beacon display text |
| BeaconEntityId | Entity of beacon in which the waypoints are in relation to |
| BeaconWorldPosition | Gets BeaconWorldPosition |
| IsPlaying | Gets bool if the PR block is playing |
| IsRecording | Get bool if the PR block is recording |
| MinimalDistance | Gets/sets minimal distance between waypoints for automatic recording to record new waypoint |
| RecordInterval | Gets/sets record interval. Sets how often the block tries to records its position as a waypoint. Operates every 100 frames |
| RepeatPath | Repeat path toggle |
| ShowPath | Gets/sets if block is showing path on clients screen |
| ShowSelectedPoints | Gets/sets if block is showing points, selected by client on his screen |
Methods
| Member | Description |
|---|---|
| Play() | Starts playing current waypoints |
| Record() | Starts recording |
| RemoveBeacon() | Sets BeaconEntityId = 0 |
| StopPlay() | Stops playing current waypoints |
| StopRecord() | Stops recording |