Skip to content

Commit f358029

Browse files
committed
Update Lua documentation for invisible emulation.
1 parent 246d29c commit f358029

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/BizHawk.Client.Common/lua/CommonLibs/ClientLuaLibrary.cs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,14 @@ public string GetLuaEngine()
9595
=> "NLua+Lua";
9696

9797
[LuaMethodExample("client.invisibleemulation( true );")]
98-
[LuaMethod("invisibleemulation", "Enters/exits turbo mode and disables/enables most emulator updates.")]
98+
[LuaMethod(
99+
name: "invisibleemulation",
100+
description: "Disables/enables invisible emulation, starting on the next frame. During invisible emulation:"
101+
+ " (1) All rendering and sound is disabled, including A/V capture."
102+
+ " (2) Emulation runs at maximum speed with turbo enabled, regardless of pause state."
103+
+ " (3) Frame rate is not calculated."
104+
+ " (4) With one additional frame of delay, state capture for rewind+TAStudio is disabled."
105+
)]
99106
public void InvisibleEmulation(bool invisible)
100107
=> APIs.EmuClient.InvisibleEmulation(invisible);
101108

0 commit comments

Comments
 (0)