Difference between revisions of "Lua Functions List"

;ActivateTriggerByName( ObjectName )

;Names["ObjectName"].Start()

:Activates a Trigger or Timeline which is loaded in the current level, using their ObjectName.

: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. Keyboard and controller have different types of movement control so it can be useful to use both.

:If you need to tilt the camera up/down, run <code>game:cameraSystem():GetDebugCam():SetAngleLock(true)</code> and use keyboard keys assigned to forward/back. Run same code but with (false) to go back to regular debugcam control scheme.

:(needs cheats enabled) Turns on the NetGui HUD, which shows other players in the same "lobby" for the current level and lets you try to manually connect to them (might only be able to show up to 4, even if there are others you can connect to), or shows your current companion.

::You can move up/down in this menu with whatever keys are assigned to move forward/back (default W/S), and select something by running '''game:netGui():ExecuteSelectedItem(game)'''. It seems you still need to be nearby a player and have the same lobby flags triggered to connect to them, or at least to stay connected.

:Changes your robe tier/color based on the number. Change is visible to companion (but maybe sometimes is not?)

:Makes an event happen as if a trigger from the level's TriggerInstances.lua had been triggered, you can do a very large amount of custom events this way.

: (This function is defined in PWeb3.lua but will not work unless you define it yourself; the default StartLua.lua will do that for you)  

:: Examples:

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

; 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, jumping really high, never truly flying, etc.

; 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.

: 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".)