# HG changeset patch
# User Wuzzy
# Date 1687362885 0
# Node ID 97c035342b4c5b9f2bf9f69888869f9e8b917ef5
# Parent  f4c68be644c2cd2a698b078c6bdb2cb4116cd9bd
LuaLibraryAnimate: Add big code example

diff -r f4c68be644c2 -r 97c035342b4c LuaLibraryAnimate.wiki
--- a/LuaLibraryAnimate.wiki	Wed Jun 21 14:31:31 2023 +0000
+++ b/LuaLibraryAnimate.wiki	Wed Jun 21 15:54:45 2023 +0000
@@ -95,6 +95,100 @@
 
 When the current animation is skipped, it is actually immediately stopped, so the game might be in a state you do not want it to be in. For example, if hogs walk in your animation, the hogs will not be in the intended position if the animation was skipped. To fix this, you need to use `AddSkipFunction` (see below for an example).
 
+=== Animation example ===
+This is the complete source code for a mission script demonstrating a simple animation in which a single hedgeghog says Hello and walks to the left. It shows the basic structure of a script using animations. This is only an example, your own implementation may vary.
+
+<code language="lua">
+HedgewarsScriptLoad("/Scripts/Animate.lua")
+
+-- Mandatory code for Animate library
+function onGameTick()
+    AnimUnWait()
+    if ShowAnimation() == false then
+        return
+    end
+    ExecuteAfterAnimations()
+    CheckEvents()
+end
+
+-- Store hegehog ID here
+local hog1
+
+function onGameInit()
+    -- Mandatory code for Animate library
+    AnimInit()
+
+    -- Configure mission
+    Map = "Ruler"
+    Theme = "Nature"
+    Explosives = 0
+    MinesNum = 0
+    CaseFreq = 0
+    GameFlags = gfOneClanMode
+
+    -- Add team and hog
+    AddTeam("Test Team", -1, "egg", "Castle", "Default_qau", "cm_test")
+    hog1 = AddHog("Hog 1", 0, 100, "NoHat")
+    SetGearPosition(hog1, 1100, 770)
+end
+
+-- Skip animation when pressing [Precise]
+function onPrecise()
+    if AnimInProgress() then
+        SetAnimSkip(true)
+    end
+end
+
+-- This function sets up the example animation
+local function addWalkAnim()
+    -- X coordinate that hog walks to
+    local goalX = 900
+
+    -- Animation example: Hog says hello and then walks to the left and then speaks again
+    local animation = {
+        -- List of animation steps
+        {func = AnimSay, args = {hog1, "Hello. I will walk to the left.", SAY_SAY, 2000}},
+        {func = AnimMove, args = {hog1, "Left", goalX, 0}},
+        {func = AnimSay, args = {hog1, "I reached my goal!", SAY_SAY, 2000}},
+    }
+
+    -- Add skip function if player presses the skip key
+    local function afterAnimSkip(args)
+        -- Teleport hog
+        SetGearPosition(hog1, goalX, GetY(hog1))
+        -- Face left (because hog walked left)
+        HogTurnLeft(hog1, true)
+        -- Stop walking
+        SetGearMessage(hog1, 0)
+    end
+    AddSkipFunction(animation, afterAnimSkip, {})
+
+    -- This will be execuded when the animation ended
+    local function afterWalkAnim()
+        AddCaption("Animation completed!")
+        ShowMission("Animation completed!", "It's over!", "You can return to the menu now.", 0, 0)
+    end
+    AddFunction({func = afterWalkAnim, args = {}})
+
+    -- Add the animation to the animation list.
+    -- In our case, it wiill be perfmored immediately.
+    AddAnim(animation)
+end
+
+-- This makes sure the animation starts on the first turn
+local hasAnimationStarted = false
+function onNewTurn()
+    if hasAnimationStarted then
+        return
+    end
+    if CurrentHedgehog ~= hog1 then
+        SwitchHog(hog1)
+    end
+    addWalkAnim()
+    hasAnimationStarted = true
+end
+</code>
+
 == Function reference ==
 === Cinematic handling ===