Onset Developer Wiki - User contributions [en]

Template:TextClientEvents

2021-10-02T13:07:46Z

Voltaism:

*[[OnText3DStreamIn]]
*[[OnText3DStreamOut]]

OnText3DStreamOut

2021-10-02T13:06:33Z

Voltaism: Create OnText3DStreamOut

{{Info|Event|Client|1.0}}

{{FuncDescription|Called when a text 3d label is streamed out from the server.}}

{{FuncSyntax|OnText3DStreamOut(text3d)}}

{{FuncParameters}}
{{FuncParam|text3d|The text3d identifier which streamed out.}}

== Example ==
<syntaxhighlight lang='Lua'>
AddEvent("OnText3DStreamOut", function (text3d)
AddPlayerChat("You streamed out the text 3d ID "..text3d..".")
end)
</syntaxhighlight>

{{RelatedFunctions}}
{{TextClientEvents}}

OnDoorStreamOut

2021-10-02T12:57:54Z

Voltaism:

{{Info|Event|Client|1.0}}

{{FuncDescription|Called when a door is streamed out from the server.}}

{{FuncSyntax|OnDoorStreamOut(door)}}

{{FuncParameters}}
{{FuncParam|door|The door identifier which streamed out.}}

== Example ==
<syntaxhighlight lang='Lua'>
AddEvent("OnDoorStreamOut", function (door)
AddPlayerChat("You streamed out the door ID "..door..".")
end)
</syntaxhighlight>

{{RelatedFunctions}}
{{DoorClientEvents}}

Template:DoorClientEvents

2021-10-02T12:57:09Z

Voltaism: Created page with "*OnDoorStreamIn *OnDoorStreamOut"

*[[OnDoorStreamIn]]
*[[OnDoorStreamOut]]

OnDoorStreamIn

2021-10-02T12:55:04Z

Voltaism:

{{Info|Event|Client|1.0}}

{{FuncDescription|This event is called when a player streams in the door.}}

{{FuncSyntax|OnDoorStreamIn(door)}}

{{FuncParameters}}
{{FuncParam|door|The door identifier which streamed in.}}

== Example ==
<syntaxhighlight lang="Lua">
AddEvent("OnDoorStreamIn", function (door)
AddPlayerChat("OH! You just streamed in a door "..door..".")
end)
</syntaxhighlight>

{{RelatedFunctions}}
{{DoorClientEvents}}

OnDoorStreamOut

2021-10-02T12:54:03Z

Voltaism: Create OnDoorStreamOut

{{Info|Event|Client|1.0}}

{{FuncDescription|Called when a door is streamed out from the server.}}

{{FuncSyntax|OnDoorStreamOut(door)}}

{{FuncParameters}}
{{FuncParam|door|The door identifier which streamed out.}}

== Example ==
===Client===
<syntaxhighlight lang='Lua'>
AddEvent("OnDoorStreamOut", function (door)
AddPlayerChat("You streamed out the door ID "..door..".")
end)
</syntaxhighlight>

{{RelatedFunctions}}
{{DoorClientEvents}}

Template:ClientEvents

2021-10-02T12:53:32Z

Voltaism:

== Game ==
{{GameClientEvents}}
== Vehicle ==
{{VehicleClientEvents}}
== Player ==
{{PlayerClientEvents}}
== Weapon ==
{{WeaponClientEvents}}
== Parachuting ==
{{ParachuteClientEvents}}
== Key ==
{{KeyClientEvents}}
== NPC ==
{{NPCClientEvents}}
== Object ==
{{ObjectClientEvents}}
== Package ==
{{PackageClientEvents}}
== Pickup ==
{{PickupClientEvents}}
== Text ==
{{TextClientEvents}}
== Vehicle ==
{{VehicleClientEvents}}
== Web UI ==
{{WebClientEvents}}
== Sound ==
{{SoundClientEvents}}
== Door ==
{{DoorClientEvents}}
== Network ==
{{NetworkClientEvents}}

OnDoorStreamIn

2021-10-02T12:47:46Z

Voltaism: Create OnDoorStreamIn

ImportPackage

2021-09-25T10:58:09Z

Voltaism:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Creates a table holding all exported functions by another package.

Another package should only be imported once by this function. The returned table is valid until package unload.}}

{{FuncSyntax|ImportPackage(PackageName)}}

{{FuncParameters}}
{{FuncParam|PackageName|Name of the package to import. Must be loaded before this one.}}

{{FuncReturnValue|Creates a table holding the other packages exported functions. Return '''nil''' if PackageName does not exist.}}

== Example ==
Package ''Test1''
<syntaxhighlight lang="Lua">
function UsefulFunc(param1, param2)
return param1 + param2
end
AddFunctionExport("UsefulFunc", UsefulFunc)
</syntaxhighlight>
Package ''Test2''
<syntaxhighlight lang="Lua">
test = ImportPackage("Test1")

print(test.UsefulFunc(2, 2))
</syntaxhighlight>
Another package should only be imported once by this function. The returned table is valid until package unload.
{{RelatedFunctions}}
[[AddFunctionExport]]

ImportPackage

2021-09-19T07:09:48Z

Voltaism:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Creates a table holding all exported functions by another package.

''ImportPackage'' can only be called once in a package serverside. The returned table is valid until package unload.}}

{{FuncSyntax|ImportPackage(PackageName)}}

{{FuncParameters}}
{{FuncParam|PackageName|Name of the package to import. Must be loaded before this one.}}

{{FuncReturnValue|Creates a table holding the other packages exported functions. Return '''nil''' if PackageName does not exist.}}

== Example ==
Package ''Test1''
<syntaxhighlight lang="Lua">
function UsefulFunc(param1, param2)
return param1 + param2
end
AddFunctionExport("UsefulFunc", UsefulFunc)
</syntaxhighlight>
Package ''Test2''
<syntaxhighlight lang="Lua">
test = ImportPackage("Test1")

print(test.UsefulFunc(2, 2))
</syntaxhighlight>
''ImportPackage'' can only be called once in a package serverside. The returned table is valid until package unload.
{{RelatedFunctions}}
[[AddFunctionExport]]

ImportPackage

2021-09-19T07:07:54Z

Voltaism:

{{Info|Function|Server & Client|1.0}}

{{FuncDescription|Creates a table holding all exported functions by another package.

''ImportPackage'' should only be called once in a package. The returned table is valid until package unload.}}

{{FuncSyntax|ImportPackage(PackageName)}}

{{FuncParameters}}
{{FuncParam|PackageName|Name of the package to import. Must be loaded before this one.}}

{{FuncReturnValue|Creates a table holding the other packages exported functions. Return '''nil''' if PackageName does not exist.}}

== Example ==
Package ''Test1''
<syntaxhighlight lang="Lua">
function UsefulFunc(param1, param2)
return param1 + param2
end
AddFunctionExport("UsefulFunc", UsefulFunc)
</syntaxhighlight>
Package ''Test2''
<syntaxhighlight lang="Lua">
test = ImportPackage("Test1")

print(test.UsefulFunc(2, 2))
</syntaxhighlight>
''ImportPackage'' can only be called once in a package serverside. The returned table is valid until package unload.
{{RelatedFunctions}}
[[AddFunctionExport]]

Voltaism Dev Tips

2021-09-15T19:41:23Z

Voltaism:

'''WIP'''

== Serverside Tips ==

==== Restart self using an exported function ====
'''Package 1:'''
<syntaxhighlight lang="Lua">
function RestartPackage(package_name)
Delay(1, function()
StopPackage(package_name)
end)
Delay(1000, function()
StartPackage(package_name)
end)
return true
end
AddFunctionExport("RestartPackage", RestartPackage)
</syntaxhighlight>

'''Package 2:'''
<syntaxhighlight lang="Lua">
local package1 = ImportPackage("package1")
package1.RestartPackage(GetPackageName())
</syntaxhighlight>

== Clientside Tips ==

==== Disable a remote player/npc collisions properly ====
<syntaxhighlight lang="Lua">
local npc_actor = GetNPCActor(npc)
local Capsule = npc_actor:GetComponentsByClass(UCapsuleComponent.Class())[1] -- Get capsule component of the npc actor
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Pawn, ECollisionResponse.ECR_Ignore) -- Disable Capsule collision with players
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Camera, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with camera
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with bullets
for i, v in ipairs(npc_actor:GetComponents()) do
if v:GetClassName() == "USkeletalMeshComponent" then
v:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable skeletal mesh component collision with bullets
end
end
</syntaxhighlight>

==== Change vehicle velocity ====
<syntaxhighlight lang="Lua">
local veh = GetPlayerVehicle(GetPlayerId())
if (veh ~= 0 and IsValidVehicle(veh) and GetVehicleDriver(veh) == GetPlayerId()) then -- The player has to be the driver or the vehicle won't be synced
local vehsk = GetVehicleSkeletalMeshComponent(veh)
vehsk:SetPhysicsAngularVelocityInDegrees(FVector(vax, vay, vaz), bAddToCurrent)
vehsk:SetPhysicsLinearVelocity(FVector(vx, vy, vz), bAddToCurrent)
end
</syntaxhighlight>

==== Change walking animations / skeleton ====
You'll need unreal engine installed in order to do this, it's experimental and it breaks [[SetPlayerAnimation]].
First make a new plugin, create an animation blueprint then make your own state machines... and link it to the output pose.
<syntaxhighlight lang="Lua">
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body") -- for an npc but you can do it with a player
local SKMesh = SKComp:GetSkeletalMesh()
SKMesh:SetPostProcessAnimBlueprint(UClass.LoadFromAsset("/vzombies/Zombie/Zombie_Anim_BP"))
SKComp:InitAnim(false)

function GetZombiePostProcessInstance(npc) -- Get the post process animation instance
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body")
return SKComp:GetPostProcessInstance()
end

local PP = GetZombiePostProcessInstance(npc)
PP:ProcessEvent("SetAttacking", true) -- You can call animation blueprint functions
</syntaxhighlight>

==== Enter a vehicle when the player press F, even while being far from the door ====
<syntaxhighlight lang="Lua">
AddEvent("OnKeyPress", function(key)
if (key == "F" and GetPlayerVehicle(GetPlayerId()) == 0) then
local veh = GetStreamedVehicles()[1]
if (veh and GetVehicleDriver(veh) == 0) then
local plyactor = GetPlayerActor()
local x, y, z = GetVehicleDoorLocation(veh, 1)
plyactor:SetActorLocation(FVector(x, y, z + 50)) -- Teleport the player at the vehicle door
end
end
end)
</syntaxhighlight>

==== Do a LineTrace from the player ====
This is the best way to do it for me, even if it returns an HitResult, it doesn't have the bug where it returns nothing if it collides at the start of
the LineTrace (And it starts from the middle of the player), i still think that adding collision with the local player to LineTraces was a bad idea.
<syntaxhighlight lang="Lua">
function LineTraceFromPlayer(ToDistanceFromPlayer, complex)
local x, y, z = GetPlayerLocation(GetPlayerId())
local fx, fy, fz = GetCameraForwardVector()
local bResult, HitResult = UKismetSystemLibrary.LineTraceSingle(GetPlayerActor(), FVector(x, y, z), FVector(x + fx * ToDistanceFromPlayer, y + fy * ToDistanceFromPlayer, z + fz * ToDistanceFromPlayer), UEngineTypes.ConvertToTraceType(ECollisionChannel.ECC_Visibility), complex, {}, EDrawDebugTrace.None, true, FLinearColor(1.0, 0.0, 0.0, 1.0), FLinearColor(0.0, 1.0, 0.0, 1.0), 10.0)
return bResult, HitResult
end

local bResult, HitResult = LineTraceFromPlayer(100, true)
if bResult then
local actor = HitResult:GetActor()
if actor then
AddPlayerChat(actor:GetName())
end
end
</syntaxhighlight>

==== Reset material slot ====
<syntaxhighlight lang="Lua">
local sk = GetPlayerSkeletalMeshComponent(GetPlayerId(), "WeaponMesh")
if sk then
sk:SetMaterial(0, UMaterialInterface.LoadFromAsset())
end
</syntaxhighlight>

== Global/Other Tips ==

==== Call/Edit a function/variable with a string ====
<syntaxhighlight lang="Lua">
_ENV["function_" .. "test"] = function(nb)
print("Hi", nb)
end
function_test(0)
_ENV["function_test"](1)

_ENV["vartest"] = 1
print(vartest)
print(_ENV["vartest"])
</syntaxhighlight>

==== Add rotations ====
<syntaxhighlight lang="Lua">
function AddRotation(r, r2)
r = r + r2
if r > 180 then
r = -180 + (r - 180)
elseif r < -180 then
r = 180 + (r + 180)
end
return r
end
local rx, ry, rz = AddRotation(120, 70), AddRotation(-160, -40), AddRotation(60, 90)
</syntaxhighlight>

==== Launch the game twice ====
Before starting, you need to have 2 steam accounts with Onset on the accounts.
First, create a folder for the steam clone, grab the steam.exe on your computer (C:\Program Files (x86)\Steam\steam.exe for me) then copy and paste this file
in the new folder. Now you need to install [https://github.com/sandboxie-plus/Sandboxie/releases Sandboxie] (I use the classic one), a third party program that allows you to
sandbox apps. Start Sandboxie, click on Sandbox --> Create New Sandbox, put a name for it then create it. Right click on the sandbox you created then go to
Sandbox Settings, go to Resource Access --> File Access --> Full Access then press '''Add''' and add the steam clone folder, save the settings. Now you can
right click on the sandbox then Run Sandboxed --> Run Any Program then start the steam.exe in the steam clone folder. Login to your alt account, install Onset and you can launch it. To close the sandbox, right click on the sandbox --> Terminate Programs.

==== Explore game files ====
This could be useful for clothes paths.
You need to install [https://www.gildor.org/en/projects/umodel umodel]. Start umodel, put the path to the game files (Steam\steamapps\common\Onset) then press OK.
Now you can explore the game files.

==== See materials slots of game static meshes ====
You'll need to [https://dev.playonset.com/wiki/Voltaism_Dev_Tips#Explore_game_files explore game files], open a static mesh then click on "StaticMesh" --> "Material IDs", then the materials IDs will be showed and they will be linked to a color so you can see where they are applied on the mesh.

IsDoorInteractable

2021-08-31T11:22:55Z

Voltaism:

{{Info|Function|Server & Client|1.5.0}}

{{FuncDescription|Checks if the door is interactable.}}

{{FuncSyntax|IsDoorInteractable(door)}}

{{FuncParameters}}
{{FuncParam|door|The door identifier.}}

{{FuncReturnValue|Returns '''true''' if the door is interactable, '''false''' if not.}}

== Example ==
<syntaxhighlight lang="Lua">

</syntaxhighlight>

{{RelatedFunctions}}
{{Template:DoorFunctions}}

Voltaism Dev Tips

2021-08-27T09:18:20Z

Voltaism: Undo revision 4928 by Voltaism (talk)

Voltaism Dev Tips

2021-07-28T09:57:07Z

Voltaism:

'''WIP'''

== Serverside Tips ==

==== Restart self using an exported function ====
'''Package 1:'''
<syntaxhighlight lang="Lua">
function RestartPackage(package_name)
Delay(1, function()
StopPackage(package_name)
end)
Delay(1000, function()
StartPackage(package_name)
end)
return true
end
AddFunctionExport("RestartPackage", RestartPackage)
</syntaxhighlight>

'''Package 2:'''
<syntaxhighlight lang="Lua">
local package1 = ImportPackage("package1")
package1.RestartPackage(GetPackageName())
</syntaxhighlight>

== Clientside Tips ==

==== Disable a remote player/npc collisions properly ====
<syntaxhighlight lang="Lua">
local npc_actor = GetNPCActor(npc)
local Capsule = npc_actor:GetComponentsByClass(UCapsuleComponent.Class())[1] -- Get capsule component of the npc actor
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Pawn, ECollisionResponse.ECR_Ignore) -- Disable Capsule collision with players
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Camera, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with camera
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with bullets
for i, v in ipairs(npc_actor:GetComponents()) do
if v:GetClassName() == "USkeletalMeshComponent" then
v:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable skeletal mesh component collision with bullets
end
end
</syntaxhighlight>

==== Change vehicle velocity ====
<syntaxhighlight lang="Lua">
local veh = GetPlayerVehicle(GetPlayerId())
if (veh ~= 0 and IsValidVehicle(veh) and GetVehicleDriver(veh) == GetPlayerId()) then -- The player has to be the driver or the vehicle won't be synced
local vehsk = GetVehicleSkeletalMeshComponent(veh)
vehsk:SetPhysicsAngularVelocityInDegrees(FVector(vax, vay, vaz), bAddToCurrent)
vehsk:SetPhysicsLinearVelocity(FVector(vx, vy, vz), bAddToCurrent)
end
</syntaxhighlight>

==== Change walking animations / skeleton ====
You'll need unreal engine installed in order to do this, it's experimental and it breaks [[SetPlayerAnimation]].
First make a new plugin, create an animation blueprint then make your own state machines... and link it to the output pose.
<syntaxhighlight lang="Lua">
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body") -- for an npc but you can do it with a player
local SKMesh = SKComp:GetSkeletalMesh()
SKMesh:SetPostProcessAnimBlueprint(UClass.LoadFromAsset("/vzombies/Zombie/Zombie_Anim_BP"))
SKComp:InitAnim(false)

function GetZombiePostProcessInstance(npc) -- Get the post process animation instance
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body")
return SKComp:GetPostProcessInstance()
end

local PP = GetZombiePostProcessInstance(npc)
PP:ProcessEvent("SetAttacking", true) -- You can call animation blueprint functions
</syntaxhighlight>

==== Enter a vehicle when the player press F, even while being far from the door ====
<syntaxhighlight lang="Lua">
AddEvent("OnKeyPress", function(key)
if (key == "F" and GetPlayerVehicle(GetPlayerId()) == 0) then
local veh = GetStreamedVehicles()[1]
if (veh and GetVehicleDriver(veh) == 0) then
local plyactor = GetPlayerActor()
local x, y, z = GetVehicleDoorLocation(veh, 1)
plyactor:SetActorLocation(FVector(x, y, z + 50)) -- Teleport the player at the vehicle door
end
end
end)
</syntaxhighlight>

==== Do a LineTrace from the player ====
This is the best way to do it for me, even if it returns an HitResult, it doesn't have the bug where it returns nothing if it collides at the start of
the LineTrace (And it starts from the middle of the player), i still think that adding collision with the local player to LineTraces was a bad idea.
<syntaxhighlight lang="Lua">
function LineTraceFromPlayer(ToDistanceFromPlayer, complex)
local x, y, z = GetPlayerLocation(GetPlayerId())
local fx, fy, fz = GetCameraForwardVector()
local bResult, HitResult = UKismetSystemLibrary.LineTraceSingle(GetPlayerActor(), FVector(x, y, z), FVector(x + fx * ToDistanceFromPlayer, y + fy * ToDistanceFromPlayer, z + fz * ToDistanceFromPlayer), UEngineTypes.ConvertToTraceType(ECollisionChannel.ECC_Visibility), complex, {}, EDrawDebugTrace.None, true, FLinearColor(1.0, 0.0, 0.0, 1.0), FLinearColor(0.0, 1.0, 0.0, 1.0), 10.0)
return bResult, HitResult
end

local bResult, HitResult = LineTraceFromPlayer(100, true)
if bResult then
local actor = HitResult:GetActor()
if actor then
AddPlayerChat(actor:GetName())
end
end
</syntaxhighlight>

==== Reset material slot ====
<syntaxhighlight lang="Lua">
local sk = GetPlayerSkeletalMeshComponent(GetPlayerId(), "WeaponMesh")
if sk then
sk:SetMaterial(0, UMaterialInterface.LoadFromAsset())
end
</syntaxhighlight>

==== Outline on component ====
SOON

== Global/Other Tips ==

==== Call/Edit a function/variable with a string ====
<syntaxhighlight lang="Lua">
_ENV["function_" .. "test"] = function(nb)
print("Hi", nb)
end
function_test(0)
_ENV["function_test"](1)

_ENV["vartest"] = 1
print(vartest)
print(_ENV["vartest"])
</syntaxhighlight>

==== Add rotations ====
<syntaxhighlight lang="Lua">
function AddRotation(r, r2)
r = r + r2
if r > 180 then
r = -180 + (r - 180)
elseif r < -180 then
r = 180 + (r + 180)
end
return r
end
local rx, ry, rz = AddRotation(120, 70), AddRotation(-160, -40), AddRotation(60, 90)
</syntaxhighlight>

==== Launch the game twice ====
Before starting, you need to have 2 steam accounts with Onset on the accounts.
First, create a folder for the steam clone, grab the steam.exe on your computer (C:\Program Files (x86)\Steam\steam.exe for me) then copy and paste this file
in the new folder. Now you need to install [https://github.com/sandboxie-plus/Sandboxie/releases Sandboxie] (I use the classic one), a third party program that allows you to
sandbox apps. Start Sandboxie, click on Sandbox --> Create New Sandbox, put a name for it then create it. Right click on the sandbox you created then go to
Sandbox Settings, go to Resource Access --> File Access --> Full Access then press '''Add''' and add the steam clone folder, save the settings. Now you can
right click on the sandbox then Run Sandboxed --> Run Any Program then start the steam.exe in the steam clone folder. Login to your alt account, install Onset and you can launch it. To close the sandbox, right click on the sandbox --> Terminate Programs.

==== Explore game files ====
This could be useful for clothes paths.
You need to install [https://www.gildor.org/en/projects/umodel umodel]. Start umodel, put the path to the game files (Steam\steamapps\common\Onset) then press OK.
Now you can explore the game files.

Voltaism Dev Tips

2021-07-21T14:35:12Z

Voltaism:

Voltaism Dev Tips

2021-07-21T14:27:40Z

Voltaism:

ClientParameters

2021-07-15T17:32:35Z

Voltaism: add -logfunctioncalls

This describes the game console parameters which can be set in Steam.

{| class="wikitable" style="text-align: left;"
|-
!Switch
!Description
|-
| -dev
|Enables the development mode. Currently this enables file logging of Lua errors and more. File is to be found under %LocalAppData%\Onset\Saved\Logs\DevLog.txt
|-
| -cefdebug=
|Specifies a different CEF remote debugging port (Default port is 9222).
|-
| -ConnectAddress=
|Connects to a specific server by ip or hostname.
|-
| -ConnectPort=
|Specifies connect port.
|-
| -ConnectPassword=
|Specifies server password.
|-
| -dx12, -dx11 (default)
|Specifies DirectX RHI version.
|-
| -windowed
|Starts game in windowed mode.
|-
| -fullscreen
|Starts game in fullscreen mode.
|-
| -statunit
|Shows the unit graph.
|-
| -logfunctioncalls
|Log Lua function calls to the dev log. (requires -dev)
|}

== Client Folder Paths ==

{| class="wikitable" style="text-align: left;"
!colspan="6"|Paths
|-
|Settings save files
|%LocalAppData%\Onset\Saved\SaveGames
|-
|Server files (client cache)
|%LocalAppData%\Onset\Saved\ServerContent
|-
|Game logs (Requires dev mode)
|%LocalAppData%\Onset\Saved\Logs
|-
|Crash dumps
|%LocalAppData%\Onset\Saved\Crashes
|-
|Custom pak files
|%LocalAppData%\Onset\Saved\PakFiles
|}

Voltaism Dev Tips

2021-07-09T10:05:19Z

Voltaism:

'''WIP'''

== Serverside Tips ==

==== Restart self using an exported function ====
'''Package 1:'''
<syntaxhighlight lang="Lua">
function RestartPackage(package_name)
Delay(1, function()
StopPackage(package_name)
end)
Delay(1000, function()
StartPackage(package_name)
end)
return true
end
AddFunctionExport("RestartPackage", RestartPackage)
</syntaxhighlight>

'''Package 2:'''
<syntaxhighlight lang="Lua">
local package1 = ImportPackage("package1")
package1.RestartPackage(GetPackageName())
</syntaxhighlight>

== Clientside Tips ==

==== Disable a remote player/npc collisions properly ====
<syntaxhighlight lang="Lua">
local npc_actor = GetNPCActor(npc)
local Capsule = npc_actor:GetComponentsByClass(UCapsuleComponent.Class())[1] -- Get capsule component of the npc actor
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Pawn, ECollisionResponse.ECR_Ignore) -- Disable Capsule collision with players
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Camera, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with camera
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with bullets
for i, v in ipairs(npc_actor:GetComponents()) do
if v:GetClassName() == "USkeletalMeshComponent" then
v:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable skeletal mesh component collision with bullets
end
end
</syntaxhighlight>

==== Change vehicle velocity ====
<syntaxhighlight lang="Lua">
local veh = GetPlayerVehicle(GetPlayerId())
if (veh ~= 0 and IsValidVehicle(veh) and GetVehicleDriver(veh) == GetPlayerId()) then -- The player has to be the driver or the vehicle won't be synced
local vehsk = GetVehicleSkeletalMeshComponent(veh)
vehsk:SetPhysicsAngularVelocityInDegrees(FVector(vax, vay, vaz), bAddToCurrent)
vehsk:SetPhysicsLinearVelocity(FVector(vx, vy, vz), bAddToCurrent)
end
</syntaxhighlight>

==== Change walking animations / skeleton ====
You'll need unreal engine installed in order to do this, it's experimental and it breaks [[SetPlayerAnimation]].
First make a new plugin, create an animation blueprint then make your own state machines... and link it to the output pose.
<syntaxhighlight lang="Lua">
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body") -- for an npc but you can do it with a player
local SKMesh = SKComp:GetSkeletalMesh()
SKMesh:SetPostProcessAnimBlueprint(UClass.LoadFromAsset("/vzombies/Zombie/Zombie_Anim_BP"))
SKComp:InitAnim(false)

function GetZombiePostProcessInstance(npc) -- Get the post process animation instance
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body")
return SKComp:GetPostProcessInstance()
end

local PP = GetZombiePostProcessInstance(npc)
PP:ProcessEvent("SetAttacking", true) -- You can call animation blueprint functions
</syntaxhighlight>

==== Enter a vehicle when the player press F, even while being far from the door ====
<syntaxhighlight lang="Lua">
AddEvent("OnKeyPress", function(key)
if (key == "F" and GetPlayerVehicle(GetPlayerId()) == 0) then
local veh = GetStreamedVehicles()[1]
if (veh and GetVehicleDriver(veh) == 0) then
local plyactor = GetPlayerActor()
local x, y, z = GetVehicleDoorLocation(veh, 1)
plyactor:SetActorLocation(FVector(x, y, z + 50)) -- Teleport the player at the vehicle door
end
end
end)
</syntaxhighlight>

==== Do a LineTrace from the player ====
This is the best way to do it for me, even if it returns an HitResult, it doesn't have the bug where it returns nothing if it collides at the start of
the LineTrace (And it starts from the middle of the player), i still think that adding collision with the local player to LineTraces was a bad idea.
<syntaxhighlight lang="Lua">
function LineTraceFromPlayer(ToDistanceFromPlayer, complex)
local x, y, z = GetPlayerLocation(GetPlayerId())
local fx, fy, fz = GetCameraForwardVector()
local bResult, HitResult = UKismetSystemLibrary.LineTraceSingle(GetPlayerActor(), FVector(x, y, z), FVector(x + fx * ToDistanceFromPlayer, y + fy * ToDistanceFromPlayer, z + fz * ToDistanceFromPlayer), UEngineTypes.ConvertToTraceType(ECollisionChannel.ECC_Visibility), complex, {}, EDrawDebugTrace.None, true, FLinearColor(1.0, 0.0, 0.0, 1.0), FLinearColor(0.0, 1.0, 0.0, 1.0), 10.0)
return bResult, HitResult
end

local bResult, HitResult = LineTraceFromPlayer(100, true)
if bResult then
local actor = HitResult:GetActor()
if actor then
AddPlayerChat(actor:GetName())
end
end
</syntaxhighlight>

== Global/Other Tips ==

==== Call/Edit a function/variable with a string ====
<syntaxhighlight lang="Lua">
_ENV["function_" .. "test"] = function(nb)
print("Hi", nb)
end
function_test(0)
_ENV["function_test"](1)

_ENV["vartest"] = 1
print(vartest)
print(_ENV["vartest"])
</syntaxhighlight>

==== Add rotations ====
<syntaxhighlight lang="Lua">
function AddRotation(r, r2)
r = r + r2
if r > 180 then
r = -180 + (r - 180)
elseif r < -180 then
r = 180 + (r + 180)
end
return r
end
local rx, ry, rz = AddRotation(120, 70), AddRotation(-160, -40), AddRotation(60, 90)
</syntaxhighlight>

==== Launch the game twice ====
Before starting, you need to have 2 steam accounts with Onset on the accounts.
First, create a folder for the steam clone, grab the steam.exe on your computer (C:\Program Files (x86)\Steam\steam.exe for me) then copy and paste this file
in the new folder. Now you need to install [https://github.com/sandboxie-plus/Sandboxie/releases Sandboxie] (I use the classic one), a third party program that allows you to
sandbox apps. Start Sandboxie, click on Sandbox --> Create New Sandbox, put a name for it then create it. Right click on the sandbox you created then go to
Sandbox Settings, go to Resource Access --> File Access --> Full Access then press '''Add''' and add the steam clone folder, save the settings. Now you can
right click on the sandbox then Run Sandboxed --> Run Any Program then start the steam.exe in the steam clone folder. Login to your alt account, install Onset and you can launch it. To close the sandbox, right click on the sandbox --> Terminate Programs.

Voltaism Dev Tips

2021-07-09T10:00:52Z

Voltaism:

'''WIP'''

== Serverside Tips ==

==== Restart self using an exported function ====
'''Package 1:'''
<syntaxhighlight lang="Lua">
function RestartPackage(package_name)
Delay(1, function()
StopPackage(package_name)
end)
Delay(1000, function()
StartPackage(package_name)
end)
return true
end
AddFunctionExport("RestartPackage", RestartPackage)
</syntaxhighlight>

'''Package 2:'''
<syntaxhighlight lang="Lua">
local package1 = ImportPackage("package1")
package1.RestartPackage(GetPackageName())
</syntaxhighlight>

== Clientside Tips ==

==== Disable a remote player/npc collisions properly ====
<syntaxhighlight lang="Lua">
local npc_actor = GetNPCActor(npc)
local Capsule = npc_actor:GetComponentsByClass(UCapsuleComponent.Class())[1] -- Get capsule component of the npc actor
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Pawn, ECollisionResponse.ECR_Ignore) -- Disable Capsule collision with players
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Camera, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with camera
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with bullets
for i, v in ipairs(npc_actor:GetComponents()) do
if v:GetClassName() == "USkeletalMeshComponent" then
v:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable skeletal mesh component collision with bullets
end
end
</syntaxhighlight>

==== Change vehicle velocity ====
<syntaxhighlight lang="Lua">
local veh = GetPlayerVehicle(GetPlayerId())
if (veh ~= 0 and IsValidVehicle(veh) and GetVehicleDriver(veh) == GetPlayerId()) then -- The player has to be the driver or the vehicle won't be synced
local vehsk = GetVehicleSkeletalMeshComponent(veh)
vehsk:SetPhysicsAngularVelocityInDegrees(FVector(vax, vay, vaz), bAddToCurrent)
vehsk:SetPhysicsLinearVelocity(FVector(vx, vy, vz), bAddToCurrent)
end
</syntaxhighlight>

==== Change walking animations / skeleton ====
You'll need unreal engine installed in order to do this, it's experimental and it breaks [[SetPlayerAnimation]].
First make a new plugin, create an animation blueprint then make your own state machines... and link it to the output pose.
<syntaxhighlight lang="Lua">
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body") -- for an npc but you can do it with a player
local SKMesh = SKComp:GetSkeletalMesh()
SKMesh:SetPostProcessAnimBlueprint(UClass.LoadFromAsset("/vzombies/Zombie/Zombie_Anim_BP"))
SKComp:InitAnim(false)

function GetZombiePostProcessInstance(npc) -- Get the post process animation instance
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body")
return SKComp:GetPostProcessInstance()
end

local PP = GetZombiePostProcessInstance(npc)
PP:ProcessEvent("SetAttacking", true) -- You can call animation blueprint functions
</syntaxhighlight>

==== Enter a vehicle when the player press F, even while being far from the door ====
<syntaxhighlight lang="Lua">
AddEvent("OnKeyPress", function(key)
if (key == "F" and GetPlayerVehicle(GetPlayerId()) == 0) then
local veh = GetStreamedVehicles()[1]
if (veh and GetVehicleDriver(veh) == 0) then
local plyactor = GetPlayerActor()
local x, y, z = GetVehicleDoorLocation(veh, 1)
plyactor:SetActorLocation(FVector(x, y, z + 50)) -- Teleport the player at the vehicle door
end
end
end)
</syntaxhighlight>

==== Do a LineTrace from the player ====
<syntaxhighlight lang="Lua">
function LineTraceFromPlayer(ToDistanceFromPlayer, complex)
local x, y, z = GetPlayerLocation(GetPlayerId())
local fx, fy, fz = GetCameraForwardVector()
local bResult, HitResult = UKismetSystemLibrary.LineTraceSingle(GetPlayerActor(), FVector(x, y, z), FVector(x + fx * ToDistanceFromPlayer, y + fy * ToDistanceFromPlayer, z + fz * ToDistanceFromPlayer), UEngineTypes.ConvertToTraceType(ECollisionChannel.ECC_Visibility), complex, {}, EDrawDebugTrace.None, true, FLinearColor(1.0, 0.0, 0.0, 1.0), FLinearColor(0.0, 1.0, 0.0, 1.0), 10.0)
return bResult, HitResult
end

local bResult, HitResult = LineTraceFromPlayer(100, true)
if bResult then
local actor = HitResult:GetActor()
if actor then
AddPlayerChat(actor:GetName())
end
end
</syntaxhighlight>

== Global/Other Tips ==

==== Call/Edit a function/variable with a string ====
<syntaxhighlight lang="Lua">
_ENV["function_" .. "test"] = function(nb)
print("Hi", nb)
end
function_test(0)
_ENV["function_test"](1)

_ENV["vartest"] = 1
print(vartest)
print(_ENV["vartest"])
</syntaxhighlight>

==== Add rotations ====
<syntaxhighlight lang="Lua">
function AddRotation(r, r2)
r = r + r2
if r > 180 then
r = -180 + (r - 180)
elseif r < -180 then
r = 180 + (r + 180)
end
return r
end
local rx, ry, rz = AddRotation(120, 70), AddRotation(-160, -40), AddRotation(60, 90)
</syntaxhighlight>

==== Launch the game twice ====
Before starting, you need to have 2 steam accounts with Onset on the accounts.
First, create a folder for the steam clone, grab the steam.exe on your computer (C:\Program Files (x86)\Steam\steam.exe for me) then copy and paste this file
in the new folder. Now you need to install [https://github.com/sandboxie-plus/Sandboxie/releases Sandboxie] (I use the classic one), a third party program that allows you to
sandbox apps. Start Sandboxie, click on Sandbox --> Create New Sandbox, put a name for it then create it. Right click on the sandbox you created then go to
Sandbox Settings, go to Resource Access --> File Access --> Full Access then press '''Add''' and add the steam clone folder, save the settings. Now you can
right click on the sandbox then Run Sandboxed --> Run Any Program then start the steam.exe in the steam clone folder. Login to your alt account, install Onset and you can launch it. To close the sandbox, right click on the sandbox --> Terminate Programs.

RotationToVector

2021-07-09T08:56:13Z

Voltaism:

{{Info|Function|Client|1.0}}

{{FuncDescription|Converts the given rotation into XYZ vectors.

https://docs.unrealengine.com/en-US/API/Runtime/Engine/Kismet/UKismetMathLibrary/Conv_RotatorToVector/index.html}}

{{FuncSyntax|RotationToVector(rx, ry, rz)}}

{{FuncParameters}}
{{FuncParam|rx|The rotation at X axis.}}
{{FuncParam|ry|The rotation at Y axis.}}
{{FuncParam|rz|The rotation at Z axis.}}

{{FuncReturnValue|Returns 3 float values, X, Y, Z}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
* [[VectorToRotation]]

RotationToVector

2021-07-09T08:55:35Z

Voltaism:

{{Info|Function|Client|1.0}}

{{FuncDescription|Converts the given rotation into XYZ vectors.

https://docs.unrealengine.com/en-US/API/Runtime/Engine/Kismet/UKismetMathLibrary/Conv_RotatorToVector/index.html}}

{{FuncSyntax|RotationToVector(rx, ry, rz)}}

{{FuncParameters}}
{{FuncParam|rx|The rotation at X axis.}}
{{FuncParam|ry|The rotation at Y axis.}}
{{FuncParam|rz|The rotation at Z axis.}}

{{FuncReturnValue|Returns 3 float values, RX, RY, RZ}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
* [[VectorToRotation]]

Voltaism Dev Tips

2021-07-08T18:30:57Z

Voltaism: Add sandboxie tip

'''WIP'''

== Serverside Tips ==

==== Restart self using an exported function ====
'''Package 1:'''
<syntaxhighlight lang="Lua">
function RestartPackage(package_name)
Delay(1, function()
StopPackage(package_name)
end)
Delay(1000, function()
StartPackage(package_name)
end)
return true
end
AddFunctionExport("RestartPackage", RestartPackage)
</syntaxhighlight>

'''Package 2:'''
<syntaxhighlight lang="Lua">
local package1 = ImportPackage("package1")
package1.RestartPackage(GetPackageName())
</syntaxhighlight>

== Clientside Tips ==

==== Disable a remote player/npc collisions properly ====
<syntaxhighlight lang="Lua">
local npc_actor = GetNPCActor(npc)
local Capsule = npc_actor:GetComponentsByClass(UCapsuleComponent.Class())[1] -- Get capsule component of the npc actor
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Pawn, ECollisionResponse.ECR_Ignore) -- Disable Capsule collision with players
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_Camera, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with camera
Capsule:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable capsule collision with bullets
for i, v in ipairs(npc_actor:GetComponents()) do
if v:GetClassName() == "USkeletalMeshComponent" then
v:SetCollisionResponseToChannel(ECollisionChannel.ECC_GameTraceChannel1, ECollisionResponse.ECR_Ignore) -- Disable skeletal mesh component collision with bullets
end
end
</syntaxhighlight>

==== Change vehicle velocity ====
<syntaxhighlight lang="Lua">
local veh = GetPlayerVehicle(GetPlayerId())
if (veh ~= 0 and IsValidVehicle(veh) and GetVehicleDriver(veh) == GetPlayerId()) then -- The player has to be the driver or the vehicle won't be synced
local vehsk = GetVehicleSkeletalMeshComponent(veh)
vehsk:SetPhysicsAngularVelocityInDegrees(FVector(vax, vay, vaz), bAddToCurrent)
vehsk:SetPhysicsLinearVelocity(FVector(vx, vy, vz), bAddToCurrent)
end
</syntaxhighlight>

==== Change walking animations / skeleton ====
You'll need unreal engine installed in order to do this, it's experimental and it breaks [[SetPlayerAnimation]].
First make a new plugin, create an animation blueprint then make your own state machines... and link it to the output pose.
<syntaxhighlight lang="Lua">
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body") -- for an npc but you can do it with a player
local SKMesh = SKComp:GetSkeletalMesh()
SKMesh:SetPostProcessAnimBlueprint(UClass.LoadFromAsset("/vzombies/Zombie/Zombie_Anim_BP"))
SKComp:InitAnim(false)

function GetZombiePostProcessInstance(npc) -- Get the post process animation instance
local SKComp = GetNPCSkeletalMeshComponent(npc, "Body")
return SKComp:GetPostProcessInstance()
end

local PP = GetZombiePostProcessInstance(npc)
PP:ProcessEvent("SetAttacking", true) -- You can call animation blueprint functions
</syntaxhighlight>

==== Enter a vehicle when the player press F, even while being far from the door ====
<syntaxhighlight lang="Lua">
AddEvent("OnKeyPress", function(key)
if (key == "F" and GetPlayerVehicle(GetPlayerId()) == 0) then
local veh = GetStreamedVehicles()[1]
if (veh and GetVehicleDriver(veh) == 0) then
local plyactor = GetPlayerActor()
local x, y, z = GetVehicleDoorLocation(veh, 1)
plyactor:SetActorLocation(FVector(x, y, z + 50)) -- Teleport the player at the vehicle door
end
end
end)
</syntaxhighlight>

== Global/Other Tips ==

==== Call/Edit a function/variable with a string ====
<syntaxhighlight lang="Lua">
_ENV["function_" .. "test"] = function(nb)
print("Hi", nb)
end
function_test(0)
_ENV["function_test"](1)

_ENV["vartest"] = 1
print(vartest)
print(_ENV["vartest"])
</syntaxhighlight>

==== Add rotations ====
<syntaxhighlight lang="Lua">
function AddRotation(r, r2)
r = r + r2
if r > 180 then
r = -180 + (r - 180)
elseif r < -180 then
r = 180 + (r + 180)
end
return r
end
local rx, ry, rz = AddRotation(120, 70), AddRotation(-160, -40), AddRotation(60, 90)
</syntaxhighlight>

==== Launch the game twice ====
Before starting, you need to have 2 steam accounts with Onset on the accounts.
First, create a folder for the steam clone, grab the steam.exe on your computer (C:\Program Files (x86)\Steam\steam.exe for me) then copy and paste this file
in the new folder. Now you need to install [https://github.com/sandboxie-plus/Sandboxie/releases Sandboxie] (I use the classic one), a third party program that allows you to
sandbox apps. Start Sandboxie, click on Sandbox --> Create New Sandbox, put a name for it then create it. Right click on the sandbox you created then go to
Sandbox Settings, go to Resource Access --> File Access --> Full Access then press '''Add''' and add the steam clone folder, save the settings. Now you can
right click on the sandbox then Run Sandboxed --> Run Any Program then start the steam.exe in the steam clone folder. Login to your alt account, install Onset and you can launch it. To close the sandbox, right click on the sandbox --> Terminate Programs.

Voltaism Dev Tips

2021-07-08T17:40:25Z

Voltaism:

Voltaism Dev Tips

2021-07-07T14:58:30Z

Voltaism:

Voltaism Dev Tips

2021-07-07T10:43:14Z

Voltaism:

Voltaism Dev Tips

2021-07-06T22:03:09Z

Voltaism:

Voltaism Dev Tips

2021-07-06T21:21:47Z

Voltaism:

Voltaism Dev Tips

2021-07-06T20:57:09Z

Voltaism: add client tip

Voltaism Dev Tips

2021-07-06T19:36:43Z

Voltaism: add client tip

Voltaism Dev Tips

2021-07-06T19:04:58Z

Voltaism:

Voltaism Dev Tips

2021-07-06T19:00:33Z

Voltaism: add tip

'''WIP'''

== Serverside Tips ==

==== SV1) Restart self using an exported function ====
'''Package 1:'''
<syntaxhighlight lang="Lua">
function RestartPackage(package_name)
Delay(1, function()
StopPackage(package_name)
end)
Delay(1000, function()
StartPackage(package_name)
end)
return true
end
AddFunctionExport("RestartPackage", RestartPackage)
</syntaxhighlight>

'''Package 2:'''
<syntaxhighlight lang="Lua">
local package1 = ImportPackage("package1")
package1.RestartPackage(GetPackageName())
</syntaxhighlight>

== Clientside Tips ==

== Global/Other Tips ==

==== G1) Call/Edit a function/variable with a string ====
<syntaxhighlight lang="Lua">
_ENV["function_" .. "test"] = function(nb)
print("Hi", nb)
end
function_test(0)
_ENV["function_test"](1)

_ENV["vartest"] = 1
print(vartest)
print(_ENV["vartest"])
</syntaxhighlight>

Voltaism Dev Tips

2021-07-06T18:27:07Z

Voltaism: added first server tip

Voltaism Dev Tips

2021-07-06T18:18:17Z

Voltaism:

WIP

== Serverside Tips ==

== Clientside Tips ==

Voltaism Dev Tips

2021-07-06T18:05:46Z

Voltaism: Created page with "WIP"

WIP