Difference between revisions of "Lua Functions List"

;ActivateTriggerByName( triggerName )

:Activates a trigger already included in TriggerInstances.lua for the current level, using that trigger's ObjectName.

;CONFIG = ...

:Changes the global variable CONFIG which shows what sort of build the game is. "Valid" options appear to be <code>Gold, PublicBeta, Demo, Production, and Debug.</code> Using anything other than Gold/PublicBeta/Demo will turn on DebugPrint which outputs some debug info to stdout.txt . Using Production or Debug might allow some scripts to work that are otherwise unusable, hasn't been fully explored.

;DumpClassInfos(c)

:A basic customized function included in StartLua.lua, which shows what is included in classes/other objects that Lua can access, printed to ClassInfo.txt in Journey root folder. Good for finding functions/variables/etc that aren't defined in the .lua's.  

:(For "c", use _G to see everything at the top level, then use the name of almost anything marked as a table to see inside of it, and to see inside deeper use TopTable.TableInside.TableDeeperInside.Etc .)

;DumpMetaSys()

:Creates TempMetasystem.lua in Journey root folder, which shows "A table of all non-abstract classes registered with the meta system". This file is useful to see all the possible triggers (will have metadata GardenerType = "Trigger") and the variables you can set for those triggers (it shows ObjectName, activityId, and lightbarId in all of them but these are not required to be set).

:(The function that the game defines in Tick.lua will crash your game; the default StartLua.lua modifies it to work the same and not crash)

:Start/stop the debug camera, which detaches from your character and can be rapidly moved all over the level. Press fly button/key to teleport your character in front of the camera. If debugHud is on, it will show the debug cam coordinates and other info.

;<nowiki>game:debugHud():CycleMode()</nowiki>

:Displays a HUD showing information about connection, cameras, trigger timelines, and memory use(?); cycles through three different levels of detail.

;<nowiki>game:netGui():ToggleEnabled()</nowiki>

;<nowiki>game:playerBarn():GetLocalDude():SetOutfit( number )</nowiki>

::0, 1, 2, 3 are red robe tiers 1, 2, 3, 4

::4, 5, 6 are white robe tiers 2, 3, 4

;<nowiki>game:playerBarn():GetLocalDude()/GetRemoteDude():GetAnimBarn():QueueAnimation( animName, blendIn, blendOut, animSpeed, numLoops, duration )</nowiki>

:Can play any animation defined in animDatas table in DudeAnimation.lua , but it seems to only be visible in your own game. LocalDude is you, RemoteDude is your companion(might only work while they are hijacked by "Nick"). :Documentation from DudeAnimation.lua: "blendIn, blendOut, and duration are in seconds. to use duration, set numLoops = 0, otherwise it will be ignored. you can set numLoops < 0 to fit a certain number of complete loops in a duration. you can set duration to be a negative number if you want it to keep playing until you stop it."

;<nowiki>game:soundBarn():ToggleMuteMusic()</nowiki>

:Toggles game music ON / OFF

;SpawnEvent{ triggertype = { var1 = a, var2 = b, etc } }

::<code>SpawnEvent { PlayDudeAnim = { animName = "Name of an animation sequence defined in DudeAnimation.lua", clearAnimQueue = true, useLocal = true}}</code>

::(plays that animation for your character, and your companion will also be able to see it. Do useLocal=false to play animations on your companion if they are currently hijacked by "Nick")

;ToggleDMActive(game)

:Toggles "Rocket Death Match" mode on and off. Chirp to shoot rockets, press fly button/key rapidly to jump. Your companion can't see your rockets/explosions/craters/etc, but they do see you moving around strangely due to the third-person-shooter controls and jumping instead of flying.

;Vars.DudeAnimation.kDebugConsoleEnabled(true)

:Toggles a debug HUD with information about player animations being used.

;Vars.Game.cheatsEnabled(true)

:Needed for NetGui HUD to be turned on, and possibly other unknown things. Is reset to "false" when game loads so you must use lua script to set it to "true".

;Vars.Lobby.kUseAutoLobby(true/false)

:Turns on/off the AutoLobby system, which is what does matchmaking. Turning off is useful to avoid meeting a random player while trying to connect to someone specific using NetGui, or for playing solo without bothering with firewall/internet connection. If AutoLobby is off, your name can't show up in NetGui for someone else unless you select "Host Game" in NetGui.

;Vars.SoundBarn.kEnableDebugHud(true/false)

:Toggles a debug HUD with information about sounds being used.

;Vars.table.setting(value)

:Changes settings controlled by Vars.lua. You can also just change the values in Journey.exe itself, but this script is good for changing things while playing, and also some things will be changed by the game when it loads and you must use this script to actually make the game do what you want.

:(See Vars.lua in Data/Scripts for possible settings: use a table/category name for "table", the specific setting name within that category for "option", and the desired value for "value".)