PortalFrameParams Class

Represents parameters required to create a portal frame

Inheritance Hierarchy

SystemObject
TSD.API.Remoting.CommonEntityParams
TSD.API.Remoting.PortalFrames.CreatePortalFrameParams

Namespace: TSD.API.Remoting.PortalFrames.Create
Assembly: TSD.API.Remoting (in TSD.API.Remoting.dll) Version: 0.22.4.0116

Syntax

public class PortalFrameParams : EntityParams

Public Class PortalFrameParams
	Inherits EntityParams

public ref class PortalFrameParams : public EntityParams

type PortalFrameParams =  
    class
        inherit EntityParams
    end

The PortalFrameParams type exposes the following members.

Properties

	Name	Description
	EntityType	The EntityType (Inherited from EntityParams.)
	Item	Gets or sets the span levels
	PointIndices	Gets the indices of construction points defining the portal frame
	SpanCount	Gets the number of spans

Methods

	Name	Description
	IrregularSpacing(IEnumerableInt32, PortalFrameSpanType)	Returns a new PortalFrameParams instance defined for irregular spacing
	IrregularSpacing(IEnumerableIConstructionPoint, PortalFrameSpanType)	Returns a new PortalFrameParams instance defined for irregular spacing
	RegularSpacing(IConstructionPoint, IConstructionPoint, Int32, PortalFrameSpanType)	Returns a new PortalFrameParams instance defined for regular spacing
	RegularSpacing(Int32, Int32, Int32, PortalFrameSpanType)	Returns a new PortalFrameParams instance defined for regular spacing