Reference API Roblox

Engine API

Website

Related

Reference API Roblox

RocketPropulsion

Applies a force so that an assembly follows and faces a target part.

This class is deprecated. It exists only for backward compatibility, and should not be used for new work. LineForce should be used instead.
Memory categoryInstances
Tags: [Deprecated]

Member index 16

HistoryMember
553CartoonFactor: float
553MaxSpeed: float
553MaxThrust: float
553MaxTorque: Vector3
553Target: BasePart
553TargetOffset: Vector3
553TargetRadius: float
553ThrustD: float
553ThrustP: float
553TurnD: float
553TurnP: float
573Abort(): null
573Fire(): null
573fire(): null
462ReachedTarget()
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

The RocketPropulsion object applies force on an assembly so that it both follows and faces a target. It acts like a hybrid of BodyPosition and BodyGyro. Unlike other BodyMovers, RocketPropulsion must be instructed to begin applying or stopping force via Fire() or Abort() respectively.

You can detect when the assembly reaches its target using the ReachedTarget event which fires once the assembly is within the TargetRadius of the Target part.

History 64

Members 16

Abort

Parameters (0)
No parameters.
Returns (1)
null

Causes the assembly to stop moving toward its Target.

Thread safetyUnsafe

History 3

CartoonFactor

TypeDefault
float0.699999988

This property determines the tendency of the assembly to face the Target. By default, this property is set to 0.7. If set to 0, the assembly will make no effort to face the target.

Thread safetyReadSafe
CategoryGoals
Loaded/Savedtrue

History 4

Fire

Parameters (0)
No parameters.
Returns (1)
null

Causes the assembly to start moving toward its Target.

Thread safetyUnsafe

History 3

MaxSpeed

TypeDefault
float30

This property determines the upper limit of the velocity at which the assembly will move toward the Target.

Thread safetyReadSafe
CategoryThrust
Loaded/Savedtrue

History 4

MaxThrust

TypeDefault
float4000

This property determines the upper limit of the thrust that may be exerted to move the assembly. Assemblies that have high mass will require more thrust in order to remain airborne and thus track the Target.

Thread safetyReadSafe
CategoryThrust
Loaded/Savedtrue

History 4

MaxTorque

TypeDefault
Vector3400000, 400000, 0

This property determines the upper limit on the amount of torque that may be exerted in order to rotate the assembly towards the Target. It functions similarly to BodyGyro.MaxTorque.

Thread safetyReadSafe
CategoryTurn
Loaded/Savedtrue

History 4

ReachedTarget

Parameters (0)
No parameters.

Fires when the assembly comes within TargetRadius of the Target.

Thread safetyUnsafe

History 2

Target

TypeDefault
BasePart

This property determines the object towards which the RocketPropulsion will exert force/torque. If set to nil, the TargetOffset will be used instead.

Thread safetyReadSafe
CategoryGoals
Loaded/Savedtrue

History 5

TargetOffset

TypeDefault
Vector30, 0, 0

This property determines the world offset from the Target. It is especially useful when Target is set to nil, since this property then acts as the target position.

Thread safetyReadSafe
CategoryGoals
Loaded/Savedtrue

History 4

TargetRadius

TypeDefault
float4

This property determines the maximum distance from the Target at which the assembly must be in order for ReachedTarget to be fired. It does not affect the exerted forces in any way.

Thread safetyReadSafe
CategoryGoals
Loaded/Savedtrue

History 4

ThrustD

TypeDefault
float0.00100000005

This property is used to dampen the velocity of the assembly in order to prevent it from overshooting the Target and causing a "rubber‑banding" effect. It behaves similarly to BodyPosition.D.

Thread safetyReadSafe
CategoryThrust
Loaded/Savedtrue

History 4

ThrustP

TypeDefault
float5

This property determines how much power is used while applying force in order to reach the Target position. The higher this value, the more power will be used and the faster it will be used. This property works similarly to BodyPosition.P.

Thread safetyReadSafe
CategoryThrust
Loaded/Savedtrue

History 4

TurnD

TypeDefault
float500

This property specifies how much dampening will be applied to the torque used to face the Target. When the assembly approaches the goal orientation, it needs to decelerate, otherwise it will rotate past the goal and have to stop and re-accelerate back toward the goal. This often creates an undesirable "rubber‑banding" effect, avoided by applying dampening. The higher this value is set, the greater the dampening curve becomes, or the slower the part will approach the goal orientation.

Thread safetyReadSafe
CategoryTurn
Loaded/Savedtrue

History 4

  • 553 Change Default of TurnD from to 500
  • 486 Change ThreadSafety of TurnD from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of TurnD from to ReadOnly
  • 47 Add TurnD

TurnP

TypeDefault
float3000

This property determines how much power is used while applying torque in order to face the Target. The higher this value, the more power will be used and the faster it will be used.

Thread safetyReadSafe
CategoryTurn
Loaded/Savedtrue

History 4

  • 553 Change Default of TurnP from to 3000
  • 486 Change ThreadSafety of TurnP from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of TurnP from to ReadOnly
  • 47 Add TurnP

fire

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Fire should be used instead.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

Settings