HSimpleVehicle

HELIX Vehicle information

💂Authority

This class can only be spawned on 🟦 Server side.

👪Inheritance

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

---

Constructor and Functions to use with the Vehicle Class.

Constructors

Default Constructor

local my_hsimplevehicle = HSimpleVehicle(location, rotation, blueprint_asset, collision_type?, gravity_enabled?)

Type	Name	Default	Description
Vector	location		Coordenates to spawn a Vehicle
Rotator	rotation		Additional rotation settings
Blueprint Reference	blueprint_asset		A Simple Vehicle blueprint is required
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

Inherited Damageable Functions

Base Damageablescripting-reference/classes/base-classes/Damageable

	Returns	Name	Description
	integer	ApplyDamage	Do damage to this entity
	integer	GetHealth	Gets the current health
	integer	GetMaxHealth	Gets the Max Health
		Respawn	Respawns the Entity, fullying it's Health and moving it to it's Initial Location
		SetHealth	Sets the Health of this Entity
		SetMaxHealth	Sets the MaxHealth of this Entity

	Returns	Name	Description
		SetSiren	Sets the state of the siren (on/off) if available
		SetHorn	Sets the state of the horn (on/off) if available
		SetDoorState	Changes the state of a selected door
		SetIsDrifting	Enables Vehicle's the drift state
		SetHoodState	Sets a state for the hood
		SetTrunkState	Sets a state for the trunk
		SetWheelState	Change wheel's state
	void	PrintData	Debug print data of the vehicle
		SetVehicleHealthState	Sets the Vehicle appearance into a state
		SetAllowEnterExitFromInteraction	This prevents Vehicle enter/exit from player interaction
		SetVehicleOwner	Sets Vehicle ownership
		SetOnlyOwnerCanInteract	Sets who can interact with the Vehicle
		SetDrift_DriftLateralForceFront	Physics calculation for the drift in Vehicle, lateral force front
		SetDrift_DriftLateralForceRear	Physics calculation for the drift in Vehicle, lateral force rear
		SetDrift_BaseLateralForceFront	Physics calculation for the drift in Vehicle, lateral force front
		SetDrift_BaseLateralForceRear	Physics calculation for the drift in Vehicle, lateral force rear
		SetDrift_DriftTorque	Physics calculation for the drift in Vehicle, drift torque
		SetDrift_BaseDriftTorque	Physics calculation for the drift in Vehicle, base drift torque
		SetDrift_LowSpeedLateralForce	Physics calculation for the drift in Vehicle, low speed lateral force
		SetTransmission_Efficiency	A simple scalar that affects only acceleration at any given gear
		SetTransmission_ShiftDelay	How long do shifts (upshift/downshift) take in seconds.
		SetTransmission_DifferentialRatio	A number that shows how many times a Vehicle's engine driveshaft turns compared to its wheels
		SetTransmission_UpshiftRatio	Ratio threshold of RPM to MaxRPM for an upshift to take place
		SetTransmission_DownshiftRatio	Ratio threshold of RPM to MaxRPM for a downshift to take place
		SetEngine_MaxTorque	This is the maximum torque that the engine will produce
		SetEngine_MaxRPM	Maximum RPM
		SetEngine_MaxReverseSpeed	This is the maximum speed (KPH) that can be achieved in reverse
		SetEngine_BrakeForce	Brake force in Newtons
		SetEngine_BrakeCoefficient	This affects how quickly the RPM decreases when the throttle is not applied
		SetAerodynamics_DragCoefficient	Set the aerodynamics for the Vehicle
		SetAerodynamics_CrossSectionArea	Vehicle Area used for AirDrag calculation
		SetWheelRadius	Set the physics wheel radius with a given float value
		SetGearRatios	Set ratios between each gear change
	integer	NumOfAllowedPassanger	Returns the number of doors the vehicle has
	integer	NumOfCurrentPassanger	Return the number of current passenger in the vehicle
	integer	GetVehicleSpeed	Returns the speed of the vehicle in kilometers per hour
	integer	GetVehicleAcceleration	Returns how fast the vehicle is accelerating
	integer	GetVehicleRPM	Returns the current RPM
	integer	GetVehicleGear	Return the current gear index

---

SetSiren

Sets the state of the siren (on/off) if available

my_hsimplevehicle:SetSiren(bSiren)

Type	Parameter	Default	Description
boolean	bSiren		True parameter adds a siren with sound to a Vehicle

---

SetHorn

Sets the state of the horn (on/off) if available

my_hsimplevehicle:SetHorn(bHorn)

Type	Parameter	Default	Description
boolean	bHorn

---

SetDoorState

Changes the state of a selected door

my_hsimplevehicle:SetDoorState(Doorindex, NewState, Curvetype)

Type	Parameter	Default	Description
integer	Doorindex		Set the door to manipulate
integer	NewState		0-Close, 1-Open 2-Broken
integer	Curvetype		0-Entering Vehicle curve, 1-Exiting Vehicle curve, 2-Normal

---

SetIsDrifting

Enables Vehicle's the drift state

my_hsimplevehicle:SetIsDrifting(bDrifting)

Type	Parameter	Default	Description
boolean	bDrifting		Enables drift state and returns to normal state after braking

---

SetHoodState

Sets a state for the hood

my_hsimplevehicle:SetHoodState(NewState, bForce)

Type	Parameter	Default	Description
integer	NewState		States: 0-Closed, 1-Open, 2-Broken
boolean	bForce		bForce=True is used at reconnecting to prevent spawning broken hood when syncing state

---

SetTrunkState

Sets a state for the trunk

my_hsimplevehicle:SetTrunkState(NewState, bForce)

Type	Parameter	Default	Description
integer	NewState		States: 0-Closed, 1-Open, 2-Broken
boolean	bForce		bForce=True is used at reconnecting to prevent spawning broken Trunk when syncing state

---

SetWheelState

Change wheel's state

my_hsimplevehicle:SetWheelState(Wheelindex, NewState)

Type	Parameter	Default	Description
integer	Wheelindex		Set the tire to modify
integer	NewState		States: 0-Normal, 1-Flat, 2-Broken

---

PrintData

Debug print data of the vehicle

— Returns void (This Function is used to debug Vehicle variables in Server console log at once).

local ret = my_hsimplevehicle:PrintData()

---

SetVehicleHealthState

Sets the Vehicle appearance into a state

my_hsimplevehicle:SetVehicleHealthState(NewState?)

Type	Parameter	Default	Description
integer	NewState?	0	State: 0-Normal, 1-Damaged, 2-Burning, 3-Broken

---

SetAllowEnterExitFromInteraction

This prevents Vehicle enter/exit from player interaction

my_hsimplevehicle:SetAllowEnterExitFromInteraction(NewAllowEnterExit?)

Type	Parameter	Default	Description
boolean	NewAllowEnterExit?	True	True allows enter/exit from vehicle

---

SetVehicleOwner

Sets Vehicle ownership

my_hsimplevehicle:SetVehicleOwner(OwnerAccountID)

Type	Parameter	Default	Description
string	OwnerAccountID		The scripter exposed function takes controller as input

---

SetOnlyOwnerCanInteract

Sets who can interact with the Vehicle

my_hsimplevehicle:SetOnlyOwnerCanInteract(NewOnlyOwnerCanInteract)

Type	Parameter	Default	Description
boolean	NewOnlyOwnerCanInteract		First set the Vehicle owner then use this function to set only owner can interact to true

---

SetDrift_DriftLateralForceFront

Physics calculation for the drift in Vehicle, lateral force front

my_hsimplevehicle:SetDrift_DriftLateralForceFront(DriftLateralForceFront)

Type	Parameter	Default	Description
integer	DriftLateralForceFront		Values can be -32,768 to 32,767

---

SetDrift_DriftLateralForceRear

Physics calculation for the drift in Vehicle, lateral force rear

my_hsimplevehicle:SetDrift_DriftLateralForceRear(DriftLateralForceRear)

Type	Parameter	Default	Description
integer	DriftLateralForceRear		Values can be -32,768 to 32,767

---

SetDrift_BaseLateralForceFront

Physics calculation for the drift in Vehicle, lateral force front

my_hsimplevehicle:SetDrift_BaseLateralForceFront(BaseLateralForceFront)

Type	Parameter	Default	Description
integer	BaseLateralForceFront		Values can be -32,768 to 32,767

---

SetDrift_BaseLateralForceRear

Physics calculation for the drift in Vehicle, lateral force rear

my_hsimplevehicle:SetDrift_BaseLateralForceRear(BaseLateralForceRear)

Type	Parameter	Default	Description
integer	BaseLateralForceRear		Values can be -32,768 to 32,767

---

SetDrift_DriftTorque

Physics calculation for the drift in Vehicle, drift torque

my_hsimplevehicle:SetDrift_DriftTorque(DriftTorque)

Type	Parameter	Default	Description
integer	DriftTorque		Values can be -32,768 to 32,767

---

SetDrift_BaseDriftTorque

Physics calculation for the drift in Vehicle, base drift torque

my_hsimplevehicle:SetDrift_BaseDriftTorque(BaseDriftTorque)

Type	Parameter	Default	Description
integer	BaseDriftTorque		Values can be -32,768 to 32,767

---

SetDrift_LowSpeedLateralForce

Physics calculation for the drift in Vehicle, low speed lateral force

my_hsimplevehicle:SetDrift_LowSpeedLateralForce(LowSpeedLateralForce)

Type	Parameter	Default	Description
integer	LowSpeedLateralForce		Values can be -32,768 to 32,767

---

SetTransmission_Efficiency

A simple scalar that affects only acceleration at any given gear

my_hsimplevehicle:SetTransmission_Efficiency(TransmissionEfficiency)

Type	Parameter	Default	Description
float	TransmissionEfficiency		Higher values result in a higher efficiency which increases acceleration. This does not affect top speed.

---

SetTransmission_ShiftDelay

How long do shifts (upshift/downshift) take in seconds.

my_hsimplevehicle:SetTransmission_ShiftDelay(ShiftDelay)

Type	Parameter	Default	Description
float	ShiftDelay

---

SetTransmission_DifferentialRatio

A number that shows how many times a Vehicle's engine driveshaft turns compared to its wheels

my_hsimplevehicle:SetTransmission_DifferentialRatio(DifferentialRatio)

Type	Parameter	Default	Description
float	DifferentialRatio

---

SetTransmission_UpshiftRatio

Ratio threshold of RPM to MaxRPM for an upshift to take place

my_hsimplevehicle:SetTransmission_UpshiftRatio(UpshiftRatio)

Type	Parameter	Default	Description
float	UpshiftRatio

---

SetTransmission_DownshiftRatio

Ratio threshold of RPM to MaxRPM for a downshift to take place

my_hsimplevehicle:SetTransmission_DownshiftRatio(DownshiftRatio)

Type	Parameter	Default	Description
float	DownshiftRatio		Gear ratios should be spaced out such that an instance of intersection between an upshift and downshift ratio occurs

---

SetEngine_MaxTorque

This is the maximum torque that the engine will produce

my_hsimplevehicle:SetEngine_MaxTorque(MaxTorque)

Type	Parameter	Default	Description
integer	MaxTorque

---

SetEngine_MaxRPM

Maximum RPM

my_hsimplevehicle:SetEngine_MaxRPM(MaxRPM)

Type	Parameter	Default	Description
integer	MaxRPM		RPM will not exceed this value unless an override is applied during runtime

---

SetEngine_MaxReverseSpeed

This is the maximum speed (KPH) that can be achieved in reverse

my_hsimplevehicle:SetEngine_MaxReverseSpeed(MaxReverseSpeed)

Type	Parameter	Default	Description
integer	MaxReverseSpeed

---

SetEngine_BrakeForce

Brake force in Newtons

my_hsimplevehicle:SetEngine_BrakeForce(BrakeForce)

Type	Parameter	Default	Description
integer	BrakeForce

---

SetEngine_BrakeCoefficient

This affects how quickly the RPM decreases when the throttle is not applied

my_hsimplevehicle:SetEngine_BrakeCoefficient(BrakeCoefficient)

Type	Parameter	Default	Description
float	BrakeCoefficient		Higher values result in a quicker decrease. Lower values result in less off-throttle deceleration

---

SetAerodynamics_DragCoefficient

Set the aerodynamics for the Vehicle

my_hsimplevehicle:SetAerodynamics_DragCoefficient(DragCoefficient)

Type	Parameter	Default	Description
float	DragCoefficient

---

SetAerodynamics_CrossSectionArea

Vehicle Area used for AirDrag calculation

my_hsimplevehicle:SetAerodynamics_CrossSectionArea(CrossSectionArea)

Type	Parameter	Default	Description
float	CrossSectionArea

---

SetWheelRadius

Set the physics wheel radius with a given float value

my_hsimplevehicle:SetWheelRadius(Wheelindex, BaseTireRadius, FlatTireRadius)

Type	Parameter	Default	Description
integer	Wheelindex
float	BaseTireRadius
float	FlatTireRadius

---

SetGearRatios

Set ratios between each gear change

my_hsimplevehicle:SetGearRatios(GearsJson)

Type	Parameter	Default	Description
string	GearsJson		Field name must be {"GearRatios": [3.5,2,1.535,1.21]}

---

NumOfAllowedPassanger

Returns the number of doors the vehicle has

— Returns integer.

local ret = my_hsimplevehicle:NumOfAllowedPassanger()

---

NumOfCurrentPassanger

Return the number of current passenger in the vehicle

— Returns integer.

local ret = my_hsimplevehicle:NumOfCurrentPassanger()

---

GetVehicleSpeed

Returns the speed of the vehicle in kilometers per hour

— Returns integer.

local ret = my_hsimplevehicle:GetVehicleSpeed()

---

GetVehicleAcceleration

Returns how fast the vehicle is accelerating

— Returns integer.

local ret = my_hsimplevehicle:GetVehicleAcceleration()

---

GetVehicleRPM

Returns the current RPM

— Returns integer.

local ret = my_hsimplevehicle:GetVehicleRPM()

---

GetVehicleGear

Return the current gear index

— Returns integer.

local ret = my_hsimplevehicle:GetVehicleGear()

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

Inherited Damageable Events

Base Damageablescripting-reference/classes/base-classes/Damageable

	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
	CharacterAttemptEnter	Triggered when a character attempts to enters the Vehicle
	CharacterEnter	Triggered when a character fully enters the Vehicle
	CharacterAttemptLeave	Triggered when a character attempts to exit the Vehicle
	CharacterLeave	Triggered when a character fully exits the Vehicle
	Horn	Horn sound emited from the Vehicle
	Siren	Siren sound emited from the Vehicle
	TakeDamage	Event for the Vehicle taking damage
	Hit	Triggered when a Vehicle is impacted from an external element

---

CharacterAttemptEnter

Triggered when a character attempts to enters the Vehicle

HSimpleVehicle.Subscribe("CharacterAttemptEnter", function(self, pawn, seat)
	-- CharacterAttemptEnter was called
end)

Type	Argument	Description
Vehicle	self
Character	pawn
integer	seat	The seat index

---

CharacterEnter

Triggered when a character fully enters the Vehicle

HSimpleVehicle.Subscribe("CharacterEnter", function(self, pawn, seat)
	-- CharacterEnter was called
end)

Type	Argument	Description
Vehicle	self
Character	pawn
integer	seat	The seat index

---

CharacterAttemptLeave

Triggered when a character attempts to exit the Vehicle

HSimpleVehicle.Subscribe("CharacterAttemptLeave", function(self, pawn)
	-- CharacterAttemptLeave was called
end)

Type	Argument	Description
Vehicle	self
Character	pawn

---

CharacterLeave

Triggered when a character fully exits the Vehicle

HSimpleVehicle.Subscribe("CharacterLeave", function(self, pawn, seat)
	-- CharacterLeave was called
end)

Type	Argument	Description
Vehicle	self
Character	pawn
integer	seat	The seat index

---

Horn

Horn sound emited from the Vehicle

HSimpleVehicle.Subscribe("Horn", function(self, NewState)
	-- Horn was called
end)

Type	Argument	Description
Vehicle	self
boolean	NewState

---

Siren

Siren sound emited from the Vehicle

HSimpleVehicle.Subscribe("Siren", function(self, NewState)
	-- Siren was called
end)

Type	Argument	Description
Vehicle	self
boolean	NewState

---

TakeDamage

Event for the Vehicle taking damage

HSimpleVehicle.Subscribe("TakeDamage", function(self, Damage, BoneName, Type, HitFromDirection, Instigator, Causer)
	-- TakeDamage was called
end)

Type	Argument	Description
Vehicle	self
integer	Damage
string	BoneName
DamageType	Type
Vector	HitFromDirection
Player	Instigator
any	Causer

---

Hit

Triggered when a Vehicle is impacted from an external element

HSimpleVehicle.Subscribe("Hit", function(self, Intensity, NormalImpulse, ImpactLocation, _Velocity)
	-- Hit was called
end)

Type	Argument	Description
Vehicle	self
float	Intensity
Vector	NormalImpulse
Vector	ImpactLocation
Vector	_Velocity