RBX.lua.RocketPropulsion (Object): Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
>N2KC
No edit summary
>Legend26
consistency
 
(36 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{CatUp|Class reference}}
{{Preliminary}}


The RocketPropulsion object is used to apply force to a Part or other object in a similiar manner as a rocket (ie. towards a given position, with given thrust and torque).
{{ObjectPage|name=RocketPropulsion|
The '''RocketPropulsion''' object is used to apply force to a Part or other object in a similiar manner as a rocket (ie. towards a given part, with given thrust and torque).<br><br>


==Functions==
'''See Also'''
In addition to the Global functions, RocketPropulsion incorporates the following:
*[[BodyThrust]]
 
*[[BodyForce]]
'''Fire()'''  - Makes the rocket fly.<br>
*[[BodyGyro]]
'''Abort()''' - Makes the rocket fall.<br>
*[[BodyVelocity]]
 
}}
 
==Properties==
In addition to the Global properties, the BodyForce also has these:
 
* [[Target]] - What [[Part]] the object will fly towards.
*MaxSpeed - How fast the rocket will fly.<br>
*CartoonFactor - In a nutshell, the tilt of the rocket as it flies.  A value of 0 will make the rocket's nose point upwards.  A value of 1 will make the rocket's nose point straight towards the Target.<br>
*TargetRadius - The radius of the Target before the ReachedTarget event is fired.<br>
*MaxThrust - The amount of thrust that is exerted on the rocket, used to keep heavier rockets airborne.<br>
* [[maxTorque]]
 
 
== Events ==
*ReachedTarget - The event that is fire when the rocket flies within the desired TargetRadius.  (This is used to make the rocket work, such as make an explosion when it flies near the Target.)
 
 
== Example Script ==
Put this script into a small, unanchored part, and change the name in the script:
<pre>
local rocket = script.Parent
 
local rp = Instance.new("RocketPropulsion")
rp.Parent = rocket
rp.Target = game.Players.YourNameHere.Character.Torso
rp:Fire()
</pre>

Latest revision as of 14:05, 18 February 2012

Preliminary:This item is under development and is likely to change. Use only for experimental work.
Derived Classes
None

The RocketPropulsion object is used to apply force to a Part or other object in a similiar manner as a rocket (ie. towards a given part, with given thrust and torque).

See Also

Fire( )
Returns nil
Description: Causes the rocket to fly towards Target.
Member of: RocketPropulsion
Abort( )
Returns nil
Description: Causes the rocket to fall.
Member of: RocketPropulsion
Clone( )
Returns Instance
Description: Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of: Instance
FindFirstChild( string name, bool recursive = false )
Returns Instance
Description: Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of: Instance
GetChildren( )
Returns table
Description: Returns a read-only table of the object's children.
Member of: Instance
GetDebugId( int scopeLength )
Returns string
Description: Returns a coded string of the object's DebugId used internally by Roblox.
Member of: Instance
GetFullName( )
Returns String path to object
Description: Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of: Instance
IsA( string className )
Returns bool
Description: Returns true if the Instance is that class or a subclass.
Member of: Instance
IsAncestorOf( Instance descendant )
Returns boolean is ancestor
Description: Returns true if the object is an ancestor of descendant.
Member of: Instance
IsDescendantOf( Instance ancestor )
Returns bool
Description: Returns true if the object is an descendant of ancestor.
Member of: Instance
Destroy( )
Returns nil
Description: Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Member of: Instance
ClearAllChildren( )
Returns nil
Description: Removes all descendants of the Instance, but leaves the Instance itself.
Member of: Instance
TurnP
Type number
Description The P in the PD controller that governs the rotation of the Rocket. The higher the number, the more aggressively the rocket will turn towards the Target.
Member of RocketPropulsion
TurnD
Property Number TurnD
Description The D in the PD controller that governs the rotation of the Rocket. Dampens the rotation of the Rocket, preventing it from overshooting.
Member of RocketPropulsion
ThrustP
Property Number ThrustP
Description The P in the PD controller that governs the motion of the Rocket. The higher the number, the more aggressively the rocket will move towards the Target.
Member of RocketPropulsion
ThrustD
Property Number ThrustD
Description The D in the PD controller that governs the motion of the Rocket. Dampens the motion of the Rocket, preventing it from overshooting.
Member of RocketPropulsion
TargetRadius
Property Number TargetRadius
Description The radius of the Target before the ReachedTarget event is fired.
Member of RocketPropulsion
TargetOffset
Property Vector3 targetOffset
Description The position from the Target which the rocket flies towards.
Member of RocketPropulsion
Target
Property Instance Target
Description What Part the object will fly towards.
Member of RocketPropulsion
maxTorque
Property Vector3 max torque on axis
Description Sets how much force can be applied to each axis.
Member of BodyGyro, RocketPropulsion, BodyAngularVelocity
MaxThrust
Property Number MaxThrust
Description The maximum thrust the rocket will exert. Heavy rockets need more thrust to remain airborne and to track the target.
Member of RocketPropulsion
MaxSpeed
Property Number MaxSpeed
Description The maximum speed of the object.
Member of RocketPropulsion
CartoonFactor
Property Number tendency to face target
Description Sets the tendency for the brick with the RocketPropulsion to face its target.
Member of RocketPropulsion
Name
Type string
Description The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of Instance
Parent
Type Instance
Description The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of Instance
Archivable
Type bool
Description Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of Instance
ClassName
Type string
Description A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of Instance
RobloxLocked
Type bool
Description 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.
Member of Instance
DataCost
Type int
Description How much saving this instance with SaveInstance will add to DataComplexity
Member of Instance
ReachedTarget ( )
Description Fired when the Rocket comes within TargetRadius of the Target. This is used to make the rocket work, such as make an explosion when it flies near the Target.
Member of: RocketPropulsion
AncestryChanged ( Instance child, Instance parent )
Description Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of: Instance
Changed ( Property property )
Description Fired whenever a property of the object changes.
Member of: Instance
ChildAdded ( Instance child )
Description Fired after a child is added.
Member of: Instance
ChildRemoved ( Instance child )
Description Fired when a child is removed from the object.
Member of: Instance
DescendantAdded ( Instance descendant )
Description Fired when a descendant is added to the object.
Member of: Instance
DescendantRemoving ( Instance descendant )
Description Fired when a descendant is being removed.
Member of: Instance