Skip to main content

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?)
TypeNameDefaultDescription
Vectorlocation
Rotatorrotation
SkeletalMesh Referenceasset
CollisionTypecollision_typeCollisionType.Normal
booleangravity_enabledtrue

Static Functions

Inherited Entity Static Functions
Base Entityscripting-reference/classes/base-classes/Entity
ReturnsNameDescription
table of Base EntityGetAllReturns a table containing all Entities of the class this is called on
Base EntityGetByIndexReturns a specific Entity of this class at an index
integerGetCountReturns how many Entities of this class exist
iteratorGetPairsReturns an iterator with all Entities of this class to be used with pairs()
tableInheritInherits this class with the Inheriting System
table of tableGetInheritedClassesGets a list of all directly inherited classes from this Class created with the Inheriting System
table or nilGetParentClassGets the parent class if this Class was created with the Inheriting System
booleanIsChildOfGets if this Class is child of another class if this Class was created with the Inheriting System
functionSubscribeSubscribes to an Event for all entities of this Class
functionSubscribeRemoteSubscribes to a custom event called from server
UnsubscribeUnsubscribes 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
ReturnsNameDescription
integerGetIDGets the universal network ID of this Entity (same on both client and server)
tableGetClassGets the class of this entity
booleanIsARecursively checks if this entity is inherited from a Class
functionSubscribeSubscribes to an Event on this specific entity
functionSubscribeRemoteSubscribes to a custom event called from server on this specific entity
UnsubscribeUnsubscribes all callbacks from this Event in this Entity within this Package, or only the callback passed
SetValueSets a Value in this Entity
anyGetValueGets a Value stored on this Entity at the given key
DestroyDestroys this Entity
booleanIsValidReturns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
CallRemoteEventCalls a custom remote event directly on this entity to a specific Player
CallRemoteEventCalls a custom remote event directly on this entity
BroadcastRemoteEventCalls a custom remote event directly on this entity to all Players
Inherited Actor Functions
Base Actorscripting-reference/classes/base-classes/Actor
ReturnsNameDescription
AddImpulseApplies a force in world world to this Actor
AttachToAttaches this Actor to any other Actor, optionally at a specific bone
DetachDetaches this Actor from AttachedTo Actor
SetCollisionSets this Actor's collision type
SetDimensionSets this Actor's Dimension
SetForceAdds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
SetGravityEnabledSets whether gravity is enabled on this Actor
SetVisibilitySets whether the actor is visible or not
SetHighlightEnabledSets whether the highlight is enabled on this Actor, and which highlight index to use
SetOutlineEnabledSets whether the outline is enabled on this Actor, and which outline index to use
SetLifeSpanSets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
SetLocationSets this Actor's location in the game world
SetRotationSets this Actor's rotation in the game world
SetRelativeLocationSets this Actor's relative location in local space (only if this actor is attached)
SetRelativeRotationSets this Actor's relative rotation in local space (only if this actor is attached)
SetScaleSets this Actor's scale
SetNetworkAuthoritySets the Player to have network authority over this Actor
SetNetworkAuthorityAutoDistributedSets if this Actor will auto distribute the network authority between players
TranslateToSmoothly moves this actor to a location over a certain time
RotateToSmoothly rotates this actor to an angle over a certain time
booleanIsBeingDestroyedReturns true if this Actor is being destroyed
booleanIsVisibleReturns true if this Actor is visible
booleanIsGravityEnabledReturns true if gravity is enabled on this Actor
booleanIsInWaterReturns true if this Actor is in water
booleanIsNetworkDistributedReturns true if this Actor is currently network distributed
table of Base ActorGetAttachedEntitiesGets all Actors attached to this Actor
Base Actor or nilGetAttachedToGets the Actor this Actor is attached to
tableGetBoundsGets this Actor's bounds
CollisionTypeGetCollisionGets this Actor's collision type
VectorGetLocationGets this Actor's location in the game world
VectorGetRelativeLocationGets this Actor's Relative Location if it's attached
Player or nilGetNetworkAuthorityGets this Actor's Network Authority Player
RotatorGetRotationGets this Actor's angle in the game world
RotatorGetRelativeRotationGets this Actor's Relative Rotation if it's attached
VectorGetForceGets this Actor's force (set by SetForce())
integerGetDimensionGets this Actor's dimension
booleanHasNetworkAuthorityReturns true if the local Player is currently the Network Authority of this Actor
booleanHasAuthorityGets if this Actor was spawned by the client side
VectorGetScaleGets this Actor's scale
VectorGetVelocityGets this Actor's current velocity
AddActorTagAdds an Unreal Actor Tag to this Actor
RemoveActorTagRemoves an Unreal Actor Tag from this Actor
table of stringGetActorTagsGets all Unreal Actor Tags on this Actor
booleanWasRecentlyRenderedGets if this Actor was recently rendered on screen
floatGetDistanceFromCameraGets the distance of this Actor from the Camera
floatGetScreenPercentageGets the percentage of this Actor size in the screen
Inherited Paintable Functions
Base Paintablescripting-reference/classes/base-classes/Paintable
ReturnsNameDescription
SetMaterialSets the material at the specified index of this Actor
SetMaterialFromCanvasSets the material at the specified index of this Actor to a Canvas object
SetMaterialFromSceneCaptureSets the material at the specified index of this Actor to a SceneCapture object
SetMaterialFromWebUISets the material at the specified index of this Actor to a WebUI object
ResetMaterialResets the material from the specified index to the original one
SetMaterialColorParameterSets a Color parameter in this Actor's material
SetMaterialScalarParameterSets a Scalar parameter in this Actor's material
SetMaterialTextureParameterSets a texture parameter in this Actor's material to an image on disk
SetMaterialVectorParameterSets a Vector parameter in this Actor's material
SetPhysicalMaterialOverrides this Actor's Physical Material with a new one
ReturnsNameDescription
SetDoorAnimationAdds a Door animation to the Vehicle
SetDoorAdds a Door to the Vehicle
PlayAnimationPlays an Animation on this Vehicle
StopAnimationStop an Animation on this Vehicle
VehiclePathGetMeshGets the Asset name
CharacterGetPassengerGets a passenger from a seat
table of CharacterGetPassengersGets all passengers
integerGetRPMGets the current RPM
integerGetGearGets the current Gear
tableGetBoneTransformGets a Bone Transform in world space given a bone name
SetCameraOffsetSets the Vehicle Camera Offset
tableGetDoorsGets all configured Doors
SetExplosionSettingsSet explosion settings.

SetDoorAnimation

Adds a Door animation to the Vehicle

my_helixvehicle:SetDoorAnimation(seat_index, animation_enter, animation_leave)
TypeParameterDefaultDescription
integerseat_index
stringanimation_enter
stringanimation_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)
TypeParameterDefaultDescription
integerseat_index
Vectoroffset_location
Vectorseat_location
Rotatorseat_rotation
integertrigger_radius
integerleave_lateral_offsetIt'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?)
TypeParameterDefaultDescription
Animation Referenceanimation_path
booleanloop_indefinitely?falseThis parameter is only used if the Vehicle has an Animation Blueprint
stringslot_name?DefaultSlot
floatblend_in_time?0.25This parameter is only used if the Vehicle has an Animation Blueprint
floatblend_out_time?0.25This parameter is only used if the Vehicle has an Animation Blueprint
floatplay_rate?1.0This parameter is only used if the Vehicle has an Animation Blueprint
booleanstop_all_montages?falseStops 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)
TypeParameterDefaultDescription
Animation Referenceanimation_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)
TypeParameterDefaultDescription
integerseat

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)
TypeParameterDefaultDescription
stringbone_name

SetCameraOffset

Sets the Vehicle Camera Offset

my_helixvehicle:SetCameraOffset(offset)
TypeParameterDefaultDescription
Vectoroffset

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)
TypeParameterDefaultDescription
Vectorengine_relative_location
Vectormaterials_override
Vectormaterials_invisible

Events

Inherited Entity Events
Base Entityscripting-reference/classes/base-classes/Entity
NameDescription
SpawnTriggered when an Entity is spawned/created
DestroyTriggered when an Entity is destroyed
ValueChangeTriggered when an Entity has a value changed with :SetValue()
ClassRegisterTriggered when a new Class is registered with the Inheriting System
Inherited Actor Events
Base Actorscripting-reference/classes/base-classes/Actor
NameDescription
SpawnTriggered when an Entity is spawned/created
DestroyTriggered when an Entity is destroyed
ValueChangeTriggered when an Entity has a value changed with :SetValue()
ClassRegisterTriggered when a new Class is registered with the Inheriting System
NameDescription
CharacterEnterTriggered when a Character fully enters the Vehicle
CharacterLeaveTriggered 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)
TypeArgumentDescription
Vehicleself
Charactercharacter
integerseatThe seat index

CharacterLeave

Triggered when a Character fully leaves the Vehicle
HELIXVehicle.Subscribe("CharacterLeave", function(self, character)
-- CharacterLeave was called
end)
TypeArgumentDescription
Vehicleself
Charactercharacter