LuaLibraryAnimate: Update SetAnimSkip for 1.0.0 draft
authorWuzzy
Tue, 07 May 2019 15:18:14 +0100
changeset 1866 0b12f567dfe3
parent 1865 af6ecc5b7dd4
child 1867 984a0cf6b491
LuaLibraryAnimate: Update SetAnimSkip for 1.0.0
LuaLibraryAnimate.wiki
--- a/LuaLibraryAnimate.wiki	Mon May 06 02:22:31 2019 +0100
+++ b/LuaLibraryAnimate.wiki	Tue May 07 15:18:14 2019 +0100
@@ -81,8 +81,10 @@
 === `SetAnimSkip(bool)` ===
 Sets the state of animation skipping to `bool`. It is useful in case the player is allowed to skip the animation.
 
+By convention, a cut scene in a singleplayer mission should be skipped when the player presses the Precise key. In this case, use the `onPreciseLocal` callback for this.
+
 Example:
-<code language="lua">function onPrecise()
+<code language="lua">function onPreciseLocal()
     if AnimInProgress() then
         SetAnimSkip(true)
     end