Interface IPortalFrame
Represents a portal frame
Inherited Members
Namespace: TSD.API.Remoting.PortalFrames
Assembly: TSD.API.Remoting.dll
Syntax
public interface IPortalFrame : IEntity, IHaveId, IHaveIndex, IHaveName, IHaveUserName, IHaveUserDefinedAttributesProperties
| Name | Description |
|---|---|
| AutoDesign | Gets a value indicating whether this portal frame is auto-designed |
| ConstructionPlaneInfo | Gets the EntityInfo of the IConstructionPlane the portal frame is constructed in |
| Offset | Gets the offset of the portal frame from the plane origin |
| OrientationFactor | Gets the orientation factor for the x-axis of the portal frame relative to the plane (either +1 or -1) |
| Plane | Gets the IPlane the portal frame is constructed in |
| ReferenceConstructionPointIndices | Gets the indices of reference IConstructionPoints of the portal frame |
| SpanCount | Gets the number of spans |
| ValleyCount | Gets the number of valleys |
Methods
| Name | Description |
|---|---|
| GetSpanAsync(IEnumerable<int>?, CancellationToken) | Returns the spans from the given indices |
| GetValleyAsync(IEnumerable<int>?, CancellationToken) | Returns the valleys from the given indices |