Prop¶
A Prop represents a Static Mesh which can be spawned in the world, can be grabbed around and have physics.
Usage¶
local MyProp = Prop(
Vector(-900, 185, 215),
Rotator(0, 90, 90),
"NanosWorld::SM_Crate_07"
)
Constructor Parameters¶
Type |
Name |
Default |
Location |
Vector(0, 0, 0) |
|
Rotation |
Rotation(0, 0, 0) |
|
ModelName |
||
CollisionType |
0 (Normal) |
|
GravityEnabled |
true |
|
IsGrabbable |
true |
Functions¶
Returns |
Name |
Description |
|
SetGrabbable(boolean) |
Sets ability to Grab this Prop |
||
GetAssetName() |
Gets the Asset name |
||
GetHandler() |
Gets the Character (if existing) which is holding this |
||
IsGrabbable() |
Gets ability to Grab this Prop |
Functions (Inherited from Actor)¶
Returns |
Name |
Description |
|
AddImpulse(Vector Force) |
Applies a Force in world coordinate on this Actor (the force is applied on Client side, by the (in most of cases) the closest player of this object) |
||
AttachTo(Actor Other, string BoneName, Vector RelativeLocation, Rotator RelativeRotation) |
Attaches this Actor to any other Actor with a Relative Offset/Rotation |
||
Destroy() |
Destroys this Actor |
||
SetCollision(number CollisionType) |
Sets the actor’s collision (0 - Normal, 1 - Static Only, 2 - No Collision) |
||
SetGravityEnabled(boolean NewGravity) |
Sets the actor’s gravity enabled |
||
SetHighlightEnabled(boolean Enabled) |
Sets if this Actors is Highlighting |
||
SetInitialLocation(Vector NewInitialLocation) |
Sets the initial location |
||
SetLocation(Vector NewLocation) |
Sets the actor’s location in the game world |
||
SetRotation(Rotator NewRotation) |
Sets the actor’s rotation in the game world |
||
SetScale(Vector Scale) |
Sets the actor’s scale |
||
SetTintColor(Color NewTintColor) |
Sets the tint color, for completely paint an object, multiply the color by 10 or 100 |
||
SetValue(string Key, any Value) |
Sets a value in this entity, which can be accessed by any package (local only) |
||
Smoothly moves this actor to a Location with a certain Speed |
|||
Smoothly rotates this actor to a Rotation with a certain Speed |
|||
IsGravityEnabled() |
Gets the actor’s gravity enabled |
||
IsValid() |
Returns if this is Valid |
||
GetCollision() |
Gets the current actor’s collision |
||
GetID() |
Gets the network ID of this entity (same in both client and server) |
||
GetLocation() |
Get the actor’s position in the game world |
||
GetInitialLocation() |
Gets the initial location |
||
GetRotation() |
Gets the actor’s rotation in the game world |
||
GetScale() |
Gets the actor’s scale |
||
GetTintColor() |
Gets the Tint Color |
||
GetType() |
Returns the type of this Actor |
||
any |
GetValue(string Key) |
Gets a value given a key |
|
GetVelocity() |
Returns the current actor Velocity |
Events¶
Name |
Arguments |
Description |
|
Grab |
When Character grabs a Prop |
||
Hit |
When this Prop hits something |
||
UnGrab |
When Character ungrabs a Prop |
Events (Inherited from Actor)¶
Name |
Arguments |
Description |
|
Destroy |
Entity actor |
Triggered when an Entity is Destroyed |
|
Spawn |
Entity actor |
Triggered when an Entity is Spawned/Created |