HELIXVehicle

Vehicles are wheeled entities which Characters can possesses and drive.

💂Authority

This class can only be spawned on 🟦 Server side.

👪Inheritance

This class shares methods and events from Base Entity, Base Actor, Base Paintable.

Any Skeletal Mesh can be used to create a Vehicle, although only Skeletal Meshes with Wheels bones can use the built-in feature of animated Wheels.

Constructors

Default Constructor

local my_helixvehicle = HELIXVehicle(location, rotation, asset, collision_type?, gravity_enabled?)

Type	Name	Default
Vector	`location`
Rotator	`rotation`
SkeletalMesh Reference	`asset`
CollisionType	`collision_type`	`CollisionType.Normal`
boolean	`gravity_enabled`	`true`

Static Functions

Inherited Entity Static Functions

Base Entityscripting-reference/classes/base-classes/Entity

Returns	Name	Description
table of Base Entity	`GetAll`	Returns a table containing all Entities of the class this is called on
Base Entity	`GetByIndex`	Returns a specific Entity of this class at an index
integer	`GetCount`	Returns how many Entities of this class exist
iterator	`GetPairs`	Returns an iterator with all Entities of this class to be used with `pairs()`
table	`Inherit`	Inherits this class with the Inheriting System
table of table	`GetInheritedClasses`	Gets a list of all directly inherited classes from this Class created with the Inheriting System
table or nil	`GetParentClass`	Gets the parent class if this Class was created with the Inheriting System
boolean	`IsChildOf`	Gets if this Class is child of another class if this Class was created with the Inheriting System
function	`Subscribe`	Subscribes to an Event for all entities of this Class
function	`SubscribeRemote`	Subscribes to a custom event called from server
	`Unsubscribe`	Unsubscribes all callbacks from this Event in this Class within this Package, or only the callback passed

This entity doesn't have own static functions.

Functions

Inherited Entity Functions

Base Entityscripting-reference/classes/base-classes/Entity

Returns	Name	Description
integer	`GetID`	Gets the universal network ID of this Entity (same on both client and server)
table	`GetClass`	Gets the class of this entity
boolean	`IsA`	Recursively checks if this entity is inherited from a Class
function	`Subscribe`	Subscribes to an Event on this specific entity
function	`SubscribeRemote`	Subscribes to a custom event called from server on this specific entity
	`Unsubscribe`	Unsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed
	`SetValue`	Sets a Value in this Entity
any	`GetValue`	Gets a Value stored on this Entity at the given key
	`Destroy`	Destroys this Entity
boolean	`IsValid`	Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
	`CallRemoteEvent`	Calls a custom remote event directly on this entity to a specific Player
	`CallRemoteEvent`	Calls a custom remote event directly on this entity
	`BroadcastRemoteEvent`	Calls a custom remote event directly on this entity to all Players

Inherited Actor Functions

Base Actorscripting-reference/classes/base-classes/Actor

Returns	Name	Description
	`AddImpulse`	Applies a force in world world to this Actor
	`AttachTo`	Attaches this Actor to any other Actor, optionally at a specific bone
	`Detach`	Detaches this Actor from AttachedTo Actor
	`SetCollision`	Sets this Actor's collision type
	`SetDimension`	Sets this Actor's Dimension
	`SetForce`	Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
	`SetGravityEnabled`	Sets whether gravity is enabled on this Actor
	`SetVisibility`	Sets whether the actor is visible or not
	`SetHighlightEnabled`	Sets whether the highlight is enabled on this Actor, and which highlight index to use
	`SetOutlineEnabled`	Sets whether the outline is enabled on this Actor, and which outline index to use
	`SetLifeSpan`	Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
	`SetLocation`	Sets this Actor's location in the game world
	`SetRotation`	Sets this Actor's rotation in the game world
	`SetRelativeLocation`	Sets this Actor's relative location in local space (only if this actor is attached)
	`SetRelativeRotation`	Sets this Actor's relative rotation in local space (only if this actor is attached)
	`SetScale`	Sets this Actor's scale
	`SetNetworkAuthority`	Sets the Player to have network authority over this Actor
	`SetNetworkAuthorityAutoDistributed`	Sets if this Actor will auto distribute the network authority between players
	`TranslateTo`	Smoothly moves this actor to a location over a certain time
	`RotateTo`	Smoothly rotates this actor to an angle over a certain time
boolean	`IsBeingDestroyed`	Returns true if this Actor is being destroyed
boolean	`IsVisible`	Returns true if this Actor is visible
boolean	`IsGravityEnabled`	Returns true if gravity is enabled on this Actor
boolean	`IsInWater`	Returns true if this Actor is in water
boolean	`IsNetworkDistributed`	Returns true if this Actor is currently network distributed
table of Base Actor	`GetAttachedEntities`	Gets all Actors attached to this Actor
Base Actor or nil	`GetAttachedTo`	Gets the Actor this Actor is attached to
table	`GetBounds`	Gets this Actor's bounds
CollisionType	`GetCollision`	Gets this Actor's collision type
Vector	`GetLocation`	Gets this Actor's location in the game world
Vector	`GetRelativeLocation`	Gets this Actor's Relative Location if it's attached
Player or nil	`GetNetworkAuthority`	Gets this Actor's Network Authority Player
Rotator	`GetRotation`	Gets this Actor's angle in the game world
Rotator	`GetRelativeRotation`	Gets this Actor's Relative Rotation if it's attached
Vector	`GetForce`	Gets this Actor's force (set by `SetForce()`)
integer	`GetDimension`	Gets this Actor's dimension
boolean	`HasNetworkAuthority`	Returns true if the local Player is currently the Network Authority of this Actor
boolean	`HasAuthority`	Gets if this Actor was spawned by the client side
Vector	`GetScale`	Gets this Actor's scale
Vector	`GetVelocity`	Gets this Actor's current velocity
	`AddActorTag`	Adds an Unreal Actor Tag to this Actor
	`RemoveActorTag`	Removes an Unreal Actor Tag from this Actor
table of string	`GetActorTags`	Gets all Unreal Actor Tags on this Actor
boolean	`WasRecentlyRendered`	Gets if this Actor was recently rendered on screen
float	`GetDistanceFromCamera`	Gets the distance of this Actor from the Camera
float	`GetScreenPercentage`	Gets the percentage of this Actor size in the screen

Inherited Paintable Functions

Base Paintablescripting-reference/classes/base-classes/Paintable

	Returns	Name	Description
		`SetMaterial`	Sets the material at the specified index of this Actor
		`SetMaterialFromCanvas`	Sets the material at the specified index of this Actor to a Canvas object
		`SetMaterialFromSceneCapture`	Sets the material at the specified index of this Actor to a SceneCapture object
		`SetMaterialFromWebUI`	Sets the material at the specified index of this Actor to a WebUI object
		`ResetMaterial`	Resets the material from the specified index to the original one
		`SetMaterialColorParameter`	Sets a Color parameter in this Actor's material
		`SetMaterialScalarParameter`	Sets a Scalar parameter in this Actor's material
		`SetMaterialTextureParameter`	Sets a texture parameter in this Actor's material to an image on disk
		`SetMaterialVectorParameter`	Sets a Vector parameter in this Actor's material
		`SetPhysicalMaterial`	Overrides this Actor's Physical Material with a new one

Returns	Name	Description
	`SetDoorAnimation`	Adds a Door animation to the Vehicle
	`SetDoor`	Adds a Door to the Vehicle
	`PlayAnimation`	Plays an Animation on this Vehicle
	`StopAnimation`	Stop an Animation on this Vehicle
VehiclePath	`GetMesh`	Gets the Asset name
Character	`GetPassenger`	Gets a passenger from a seat
table of Character	`GetPassengers`	Gets all passengers
integer	`GetRPM`	Gets the current RPM
integer	`GetGear`	Gets the current Gear
table	`GetBoneTransform`	Gets a Bone Transform in world space given a bone name
	`SetCameraOffset`	Sets the Vehicle Camera Offset
table	`GetDoors`	Gets all configured Doors
	`SetExplosionSettings`	Set explosion settings.

`SetDoorAnimation`

Adds a Door animation to the Vehicle

my_helixvehicle:SetDoorAnimation(seat_index, animation_enter, animation_leave)

Type	Parameter	Default	Description
integer	`seat_index`
string	`animation_enter`
string	`animation_leave`

`SetDoor`

Adds a Door at offset_location from root which will pose the Character at seat_location with seat_rotation rotation.

my_helixvehicle:SetDoor(seat_index, offset_location, seat_location, seat_rotation, trigger_radius, leave_lateral_offset)

Type	Parameter	Description
integer	`seat_index`
Vector	`offset_location`
Vector	`seat_location`
Rotator	`seat_rotation`
integer	`trigger_radius`
integer	`leave_lateral_offset`	It's where the Character will be ejected when leaving it (e.g. -150 for left door or 150 for right door)

`PlayAnimation`

Plays an Animation on this Vehicle

my_helixvehicle:PlayAnimation(animation_path, loop_indefinitely?, slot_name?, blend_in_time?, blend_out_time?, play_rate?, stop_all_montages?)

Type	Parameter	Default	Description
Animation Reference	`animation_path`
boolean	`loop_indefinitely?`	`false`	This parameter is only used if the Vehicle has an Animation Blueprint
string	`slot_name?`	`DefaultSlot`
float	`blend_in_time?`	`0.25`	This parameter is only used if the Vehicle has an Animation Blueprint
float	`blend_out_time?`	`0.25`	This parameter is only used if the Vehicle has an Animation Blueprint
float	`play_rate?`	`1.0`	This parameter is only used if the Vehicle has an Animation Blueprint
boolean	`stop_all_montages?`	`false`	Stops all running Montages from the same Group. This parameter is only used if the Vehicle has an Animation Blueprint

`StopAnimation`

Stop an Animation on this Vehicle

my_helixvehicle:StopAnimation(animation_path)

Type	Parameter	Default	Description
Animation Reference	`animation_path`

`GetMesh`

Gets the Asset name

— Returns VehiclePath (asset path).

local ret = my_helixvehicle:GetMesh()

`GetPassenger`

Gets a passenger from a seat

— Returns Character (or nil if no passenger in seat).

local ret = my_helixvehicle:GetPassenger(seat)

Type	Parameter	Default	Description
integer	`seat`

`GetPassengers`

Gets all passengers

— Returns table of Character.

local ret = my_helixvehicle:GetPassengers()

`GetRPM`

Gets the current RPM

— Returns integer.

local ret = my_helixvehicle:GetRPM()

`GetGear`

Gets the current Gear

— Returns integer.

local ret = my_helixvehicle:GetGear()

`GetBoneTransform`

Gets a Bone Transform in world space given a bone name

— Returns table (with this format).

local ret = my_helixvehicle:GetBoneTransform(bone_name)

Type	Parameter	Default	Description
string	`bone_name`

`SetCameraOffset`

Sets the Vehicle Camera Offset

my_helixvehicle:SetCameraOffset(offset)

Type	Parameter	Default	Description
Vector	`offset`

`GetDoors`

Gets all configured Doors

— Returns table (with this format).

local ret = my_helixvehicle:GetDoors()

`SetExplosionSettings`

Set explosion settings.

my_helixvehicle:SetExplosionSettings(engine_relative_location, materials_override, materials_invisible)

Type	Parameter	Default	Description
Vector	`engine_relative_location`
Vector	`materials_override`
Vector	`materials_invisible`

Events

Inherited Entity Events

Base Entityscripting-reference/classes/base-classes/Entity

	Name	Description
	`Spawn`	Triggered when an Entity is spawned/created
	`Destroy`	Triggered when an Entity is destroyed
	`ValueChange`	Triggered when an Entity has a value changed with `:SetValue()`
	`ClassRegister`	Triggered when a new Class is registered with the Inheriting System

Inherited Actor Events

Base Actorscripting-reference/classes/base-classes/Actor

	Name	Description
	`Spawn`	Triggered when an Entity is spawned/created
	`Destroy`	Triggered when an Entity is destroyed
	`ValueChange`	Triggered when an Entity has a value changed with `:SetValue()`
	`ClassRegister`	Triggered when a new Class is registered with the Inheriting System

	Name	Description
	`CharacterEnter`	Triggered when a Character fully enters the Vehicle
	`CharacterLeave`	Triggered when a Character fully leaves the Vehicle

`CharacterEnter`

Triggered when a Character fully enters the Vehicle

HELIXVehicle.Subscribe("CharacterEnter", function(self, character, seat)
	-- CharacterEnter was called
end)

Type	Argument	Description
Vehicle	`self`
Character	`character`
integer	`seat`	The seat index

`CharacterLeave`

Triggered when a Character fully leaves the Vehicle

HELIXVehicle.Subscribe("CharacterLeave", function(self, character)
	-- CharacterLeave was called
end)

Type	Argument	Description
Vehicle	`self`
Character	`character`

Constructors​

Default Constructor​

Static Functions​

Functions​

SetDoorAnimation​

SetDoor​

PlayAnimation​

StopAnimation​

GetMesh​

GetPassenger​

GetPassengers​

GetRPM​

GetGear​

GetBoneTransform​

SetCameraOffset​

GetDoors​

SetExplosionSettings​

Events​

CharacterEnter​

CharacterLeave​

Constructors

Default Constructor

Static Functions

Functions

`SetDoorAnimation`

`SetDoor`

`PlayAnimation`

`StopAnimation`

`GetMesh`

`GetPassenger`

`GetPassengers`

`GetRPM`

`GetGear`

`GetBoneTransform`

`SetCameraOffset`

`GetDoors`

`SetExplosionSettings`

Events

`CharacterEnter`

`CharacterLeave`