API:Class/AlignPosition

AlignPosition : Constraint : Instance

An AlignPosition is used to apply a force towards a location. Like other constraints, AlignPositions have two Attachments. In this case the attachments are constrained to be in the same position, although not necessarily in the same orientation. By default, this constraint only applies forces on Attachment0, although it can be configured to apply forces on both attachments.

Properties

PropertiesmemberhiddenProperties [toggle]

boolApplyAtCenterOfMass

When true, applies force at center of mass of Attachment0’s parent Part. When false, applied at Attachment0.

floatMaxForce

Maximum force the constraint can apply to achieve its goal. Only used if RigidityEnabled is false.

floatMaxVelocity

Maximum speed the Attachment can move when converging. Only used if RigidityEnabled is false.

boolReactionForceEnabled

When true the constraint will apply force on both Attachments to achieve the goal.

floatResponsiveness

Used to control how quickly the constraint will reach its goal. Higher values will cause the attachments to move together quicker. Value can be between 5 and 200.

boolRigidityEnabled

When set to true, the solver will react as quickly as possible to move the attachments together. When false, the torque is dependent on MaxForce, MaxVelocity, and Responsiveness.

bool	ApplyAtCenterOfMass	When true, applies force at center of mass of Attachment0’s parent Part. When false, applied at Attachment0.
float	MaxForce	Maximum force the constraint can apply to achieve its goal. Only used if RigidityEnabled is false.
float	MaxVelocity	Maximum speed the Attachment can move when converging. Only used if RigidityEnabled is false.
bool	ReactionForceEnabled	When true the constraint will apply force on both Attachments to achieve the goal.
float	Responsiveness	Used to control how quickly the constraint will reach its goal. Higher values will cause the attachments to move together quicker. Value can be between 5 and 200.
bool	RigidityEnabled	When set to true, the solver will react as quickly as possible to move the attachments together. When false, the torque is dependent on MaxForce, MaxVelocity, and Responsiveness.

Inherited from

Constraint:

Ref<Attachment>Attachment0

The Attachment that is connected to Attachment1.

Ref<Attachment>Attachment1

The Attachment that is connected to Attachment0.

BrickColorColor

The color of the constraint.

boolEnabled

Toggles whether or not this Constraint is enabled.

boolVisible

Toggles the visibility of this Constraint.

Ref<Attachment>	Attachment0	The Attachment that is connected to Attachment1.
Ref<Attachment>	Attachment1	The Attachment that is connected to Attachment0.
BrickColor	Color	The color of the constraint.
bool	Enabled	Toggles whether or not this Constraint is enabled.
bool	Visible	Toggles the visibility of this Constraint.

Inherited from

Instance:

boolArchivable

Determines if an object can be Cloned or saved to file.

stringClassName [readonly]

The unique name of this type of Instance.

stringName

A non-unique identifier for the object.

Ref<Instance>Parent

The hierarchical parent of the object.

int~~DataCost~~ [LocalUserSecurity] [deprecated] [readonly]

Deprecated. Do not use.

boolRobloxLocked [PluginSecurity]

If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

bool~~archivable~~ [deprecated] [hidden]

Deprecated in favor of Archivable.

string~~className~~ [deprecated] [readonly]

Deprecated in favor of ClassName.

bool	Archivable	Determines if an object can be Cloned or saved to file.
string	ClassName [readonly]	The unique name of this type of Instance.
string	Name	A non-unique identifier for the object.
Ref<Instance>	Parent	The hierarchical parent of the object.
int	~~DataCost~~ [LocalUserSecurity] [deprecated] [readonly]	Deprecated. Do not use.
bool	RobloxLocked [PluginSecurity]	If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
bool	~~archivable~~ [deprecated] [hidden]	Deprecated in favor of Archivable.
string	~~className~~ [deprecated] [readonly]	Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

Inherited from

Instance:

voidClearAllChildren ( )

Removes all descendants of the object.

Ref<Instance>Clone ( )

Returns a copy of the object, including descendants, but only if the object is Archivable.

voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

array<Instance>GetChildren ( )

Returns an array of the object's children.

array<Instance>GetDescendants ( )

Returns an array containing all of the descendants of the instance.

stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

void	ClearAllChildren ( )	Removes all descendants of the object.
Ref<Instance>	Clone ( )	Returns a copy of the object, including descendants, but only if the object is Archivable.
void	Destroy ( )	Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Ref<Instance>	FindFirstAncestor ( string name )	Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Ref<Instance>	FindFirstAncestorOfClass ( string className )	Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Ref<Instance>	FindFirstAncestorWhichIsA ( string className )	Returns the first ancestor that inherits the class className, or nil if none can be found.
Ref<Instance>	FindFirstChild ( string name, bool recursive = false )	Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Ref<Instance>	FindFirstChildOfClass ( string className )	Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
Ref<Instance>	FindFirstChildWhichIsA ( string className, bool recursive = false )	Returns the first child that inherits the class className, or nil if none can be found.
array<Instance>	GetChildren ( )	Returns an array of the object's children.
array<Instance>	GetDescendants ( )	Returns an array containing all of the descendants of the instance.
string	GetFullName ( )	Returns a string which shows the object's ancestry chain.
RBXScriptSignal	GetPropertyChangedSignal ( string property )	Returns a signal that is fired when the specified property is changed on this object.
bool	IsA ( string className )	Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
bool	IsAncestorOf ( Instance descendant )	Returns true if the object is an ancestor of the given descendant.
bool	IsDescendantOf ( Instance ancestor )	Returns true if the object is a descendant of the given ancestor.
Ref<Instance>	WaitForChild ( string childName, double timeOut )	Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
string	GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]	Returns a coded string of the object's DebugId used internally by Roblox.
void	~~Remove~~ ( ) [deprecated]	Deprecated. Do not use.
array<Instance>	~~children~~ ( ) [deprecated]	Deprecated in favor of GetChildren.
Instance	~~clone~~ ( ) [deprecated]	Deprecated in favor of Clone.
void	~~destroy~~ ( ) [deprecated]	Deprecated in favor of Destroy.
Instance	~~findFirstChild~~ ( string name, bool recursive = false ) [deprecated]	Deprecated in favor of FindFirstChild.
array<Instance>	~~getChildren~~ ( ) [deprecated]	Deprecated in favor of GetChildren.
bool	~~isA~~ ( string className ) [deprecated]	Deprecated in favor of IsA.
bool	~~isDescendantOf~~ ( Instance ancestor ) [deprecated]	Deprecated in favor of IsDescendantOf.
void	~~remove~~ ( ) [deprecated]	Deprecated in favor of Remove.

Events

EventsmemberhiddenEvents [toggle]

Inherited from

Instance:

AncestryChanged ( Instance child, Instance parent )

Fires when the Parent property of the object or one of its ancestors is changed.

Changed ( string property )

Fires after a property of the object changes.

ChildAdded ( Instance child )

Fires when a child is added to the object.

ChildRemoved ( Instance child )

Fires when a child is removed from the object.

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

~~childAdded~~ ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

	AncestryChanged ( Instance child, Instance parent )	Fires when the Parent property of the object or one of its ancestors is changed.
	Changed ( string property )	Fires after a property of the object changes.
	ChildAdded ( Instance child )	Fires when a child is added to the object.
	ChildRemoved ( Instance child )	Fires when a child is removed from the object.
	DescendantAdded ( Instance descendant )	Fires when a descendant is added to the object.
	DescendantRemoving ( Instance descendant )	Fires before a descendant of the object is removed.
	~~childAdded~~ ( Instance child ) [deprecated]	Deprecated in favor of ChildAdded.