|
|
(29 intermediate revisions by 9 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 part, 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]] - The maximum amount of force that is used to turn the rocket. | |
| | |
| | |
| == 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 ==
| |
| Insert 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>
| |
Preliminary:This item is under development and is likely to change. Use only for experimental work.
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
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
|
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
|
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
|
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
|
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
|
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
|