This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| common-refmat:havok_behavior_script [2026/10/03 16:18] – admin | common-refmat:havok_behavior_script [2026/10/03 16:30] (current) – admin | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| Covers all of the exposed functions available within Havok Script files (.hks). | Covers all of the exposed functions available within Havok Script files (.hks). | ||
| - | ===== Havok Built-in (General) ===== | + | Havok Script exposes the following Lua libraries: |
| + | * debug | ||
| + | * io | ||
| + | * coroutine | ||
| + | * math | ||
| + | * os | ||
| + | * package | ||
| + | * profile | ||
| + | * serialize | ||
| + | * string | ||
| + | * struct | ||
| + | * table | ||
| + | |||
| + | ===== General ===== | ||
| ^ Name ^ Parameters ^ Notes ^ | ^ Name ^ Parameters ^ Notes ^ | ||
| | act | <action id>, < | | act | <action id>, < | ||
| + | | env | < | ||
| | ActivateRightArmAdd | <frame index>: | ? | | | ActivateRightArmAdd | <frame index>: | ? | | ||
| - | | assert | ? | ? | | ||
| | CalcArmTwistAngle | ? | ? | | | CalcArmTwistAngle | ? | ? | | ||
| | ChangeWaistTwist | <a>, <b>, <c>, <d> | ? | | | ChangeWaistTwist | <a>, <b>, <c>, <d> | ? | | ||
| - | | collectgarbage | ? | ? | | ||
| | ConvergeValue | <value 1>, <value 2>, < | | ConvergeValue | <value 1>, <value 2>, < | ||
| | DebugPrint | < | | DebugPrint | < | ||
| - | | dofile | ? | ? | | ||
| - | | dummy | ? | ? | | ||
| - | | env | < | ||
| - | | error | ? | ? | | ||
| | ForwardLeg | - | Returns the index of the forward leg | | | ForwardLeg | - | Returns the index of the forward leg | | ||
| - | | getfenv | ? | ? | | ||
| - | | getmetatable | ? | Lua table function. | | ||
| - | | hpairs | ? | Lua table function. | | ||
| | IncNum | ? | ? | | | IncNum | ? | ? | | ||
| + | | IsRightArmAddState | ? | ? | | ||
| + | | PrintString | ? | ? | | ||
| + | | RightArmLocation | ? | ? | | ||
| + | | SetTimeActEditorVariable | ? | ? | | ||
| + | | UpdateFemaleBlend | ? | ? | | ||
| + | | UpdateRightArmAdd | ? | ? | | ||
| + | | UpdateShoulderTwist | ? | ? | | ||
| + | | UpdateWristTwist | ? | ? | | ||
| - | ===== Havok Built-in (Behavior) | + | ===== Havok-Specific |
| ^ Name ^ Parameters ^ Notes ^ | ^ Name ^ Parameters ^ Notes ^ | ||
| | hkbAssignLineDockingTarget | ? | ? | | | hkbAssignLineDockingTarget | ? | ? | | ||
| Line 57: | Line 70: | ||
| | hkbUnloadAnimationAssets | ? | ? | | | hkbUnloadAnimationAssets | ? | ? | | ||
| - | ===== Coroutine===== | + | ===== havokscript |
| - | ^ Name ^ Parameters ^ Notes ^ | + | |
| - | | coroutine.create | ? | ? | | + | |
| - | | coroutine.getname | ? | ? | | + | |
| - | | coroutine.resume | ? | ? | | + | |
| - | | coroutine.running | ? | ? | | + | |
| - | | coroutine.setname | ? | ? | | + | |
| - | | coroutine.status | ? | ? | | + | |
| - | | coroutine.wrap | ? | ? | | + | |
| - | | coroutine.create | ? | ? | | + | |
| - | | coroutine.yield | ? | ? | | + | |
| - | + | ||
| - | ===== Debug ===== | + | |
| - | ^ Name ^ Parameters ^ Notes ^ | + | |
| - | | debug.c_breakpoint | ? | ? | | + | |
| - | | debug.getfenv | ? | ? | | + | |
| - | | debug.getinfo | ? | ? | | + | |
| - | | debug.getlocal | ? | ? | | + | |
| - | | debug.getmetatable | ? | ? | | + | |
| - | | debug.getregistry | ? | ? | | + | |
| - | | debug.getupvalue | ? | ? | | + | |
| - | | debug.inspect | ? | ? | | + | |
| - | | debug.print | ? | ? | | + | |
| - | | debug.setfenv | ? | ? | | + | |
| - | | debug.setfname | ? | ? | | + | |
| - | | debug.setlocal | ? | ? | | + | |
| - | | debug.setmetatable | ? | ? | | + | |
| - | | debug.setupvalue | ? | ? | | + | |
| - | | debug.traceback | ? | ? | | + | |
| - | + | ||
| - | ===== HavokScript | + | |
| ^ Name ^ Parameters ^ Notes ^ | ^ Name ^ Parameters ^ Notes ^ | ||
| | havokscript.compilerSettings | ? | ? | | | havokscript.compilerSettings | ? | ? | | ||