Stge基礎教學

這篇文章作為stge script的入門教學，會告訴你如何撰寫stge script來描述簡單的彈幕效果並整合到good裡，透過good的顯示功能呈現到畫面上。要補充說明的是，雖然stge script最初是為了射擊遊戲而設計的，但因為它也有基本足夠的彈性，所以也能夠作為粒子效果來應用。

;

1, 首先打開good Game Editor，按下Ctrl+S儲存空白專案，命名為StgeTest1.txt。
2, 接著在工具列上點擊新增空白關卡(New Level)，或點擊選單Project->New Level...加入空白關卡。
3, 在新關卡(level1)的屬性檢視器上的ClearColor，開啟顏色選擇對話盒並設定成黑色。
4, 在工具列上點擊新增空白腳本(New Script)，或點擊選單Project->New Script...加入空白腳本，檔案名稱填StgeTest1.lua。
5, 在資源樹上點擊level1回到空白關卡1的屬性檢視器，在Script欄位上填入Level。
6, 按下Ctrl+S儲存檔案。

現在已建立基本的資源，接下來全部使用script來建立我們要的功能。首先撰寫一些good script作出基本框架。

Level= {}

Level.OnCreate = function(param)
  Stge.RunScript('StgeTest1')
end

Level.OnNewParticle = function(param, particle)
  local obj = Good.GenObj(-1, -1)
  Good.SetDim(obj, 0,0, 3, 3)
  Good.SetBgColor(obj, 0xffff0000)
  Stge.BindParticle(particle, obj)
end

Level.OnKillParticle = function(param, particle)
  Good.KillObj(Stge.GetParticleBind(particle))
end

如上，我們有個叫作Level的table，並加入了三個空白的function，這三個function是good預先定義的event。OnCreate是當物件建立時會被呼叫，並且只會被呼叫一次，我們可以在這個event裡作些初始化相關工作。如上面的例子所示，我們在OnCreate事件中起動了一個叫作StgeTest1的stge script。

OnNewParticle和OnKillParticl才是和Stge有關的event。當有個新的粒子被建立出來時會觸發此事件，我們可以利用這個事件把stge粒子和good物件綁定(Bind)，讓stge粒子來控制畫面上顯示的good物件。相反的當粒子要釋放時會觸發OnKillParticle，這時我們再把產生出來的good物件也一起釋放掉。

在上面的例子中，我們在OnNewParticle事件發生時，同時建立一個大小是8x8的紅色色塊，並把這個物件和粒子作綁定。而在OnKillParticle事件觸發時，再透過GetParticleBind取得所綁定的物件並把它一起Kill掉。

7, 接著在工具列上點擊新增空白stge腳本(New Particle)，或點擊選單Project->New Particle...加入空白stge腳本，檔案名稱填StgeTest1.stge，接著在StgeTest1.stge文建內寫下如下的script。

script StgeTest1
  fire()
end

儲檔後可以按下工具列上的Play或F5執行看看，應該會顯示一個全黑的畫面，而畫面正中央有個紅色方塊。我們已發射了一枚粒子出來，並如我們所設定的和一個紅色色塊綁定，只不過它還不會動！

現在按下ESC退出程式，現在我們要加點程式讓粒子動起來。

;

首先要先說明一下需要注意的地方。good的座標系原點是在左上角，而stge的座標系原點在正中央，這就是為什麼這個粒子會在畫面正中央。同時good座標系和一般的銀幕座標系一樣往右往下是正的，而stge座標系是往右往上是正的，和一般我們在學習數學時的笛卡兒作標系定義相同。

;

stge script都是以一個script關鍵字開始，接著一個名稱，最後再以一個end關鍵字結尾，和lua的function有點類似。你可以寫很多個script，然後再用Stge.RunScript以script名稱來個別執行它。

fire指令是用來發射一枚粒子的。因為我們還沒有指定速度給它，預設速度是0，所以它才維持在畫面正中不動。現在我們要把它加上速度，同時也給它一個方向。

script StgeTest1
  direction(0)
  speed(120)
  fire()
end

direction是用來設定方向的，單位是度。0度是x軸的正方向也就是正右，90度是正下，所以角度是順時針方向。有效值是0-360間，比360大或比0小時會自動調整。方向的預設值也是0，所以direction(0)也可以省略不寫。speed則是用來設定移動速度，單位是每秒移動的pixel量。

現在再執行程式，可以看到這個粒子往右動了起來了！

;

如果要發射二枚粒子，只要呼叫二次fire指令就行了，如下所示。

script StgeTest1
  direction(0)
  speed(120)
  fire()
  direction(45)
  fire()
end

這次同時發射了二枚粒子，一個朝0度方向飛去，另一個朝45度方向飛去。

在上面的例子裡注意到，我在第二次射擊時沒有再以speed設定一次速度，因為只要設定過的方向或速度，在下次改變時會一直保留狀態，所以我們不必每次都作設定。

;

現在有個問題了，如果要一定射擊多發子彈，那就要呼叫很多次fire才行，這不是一個好辨法。所以我們需要迴圈，如下所示。

script StgeTest1
  speed(120)
  repeat(12)
    direction(30, add)
    fire()
  end
end

執行上面的範例，可以看到朝四面八方發射了一個有12個粒子的環。

repeat就是我們使用的迴圈指令，它最後需要以一個end關鍵字作結束。在這個區塊裡的指令，會重覆執行repeat所指定的數量。而direction的add參數則是指定說，以上一次的設定值，累加30度的意思，所以每一次執行會以間隔30度的角度發射一枚粒子出去。

接下來我們對程式作一點點如下的小修改，再執行看看。

script StgeTest1
  speed(120)
  repeat(-1)
    direction(30, add)
    fire()
    sleep(0.1)
 end
end

我們可以看到畫面上，不斷的以螺旋的方式發射出粒子。

把repeat的執行數量改成-1，就表示為無窮迴圈的意思，所以它才會不停的發射粒子。而我們在fire之後插入了一條sleep指令，這是用來暫停執行的指令，暫停的時間我們指定為0.1秒。所以執行結果會變成，每次間隔0.1秒會射擊一枚粒子，並一直不斷的重覆這個動作直到結束。

;

接著我們要來製作子母彈，程式改成如下。

script StgeTest1
  speed(120)
  repeat(-1)
    direction(30, add)
    fire(sub1)
    sleep(0.1)
 end
end

script sub1
  sleep(rand(2,4))
  speed(120)
  repeat(10)
    direction(36, add)
    fire()
  end
end

注意我們在StgeTest1裡的fire指令指定了一個叫sub1的參數，sub1又是另一個script，這表示說我們發射出來的粒子會和sub1綁定，由sub1來控制。而因為sub1又是另一個script，因此StgeTest1能作的事sub1也能作到，也就是說被發射出來粒子還能夠發射粒子！

sub1的執行的動作比較特別的是一開始的sleep指令，我給它一個rand(2,4)參數，透過rand指令我可以得到一個2-4間的亂數，這樣就能作出一些變化。rand指令除了有rand(a,b)的形式外，也還能用rand()產生0-1間的亂數，或rand(a)產生0-a間的亂數。

sub1暫停一小段時間後，會炸開一個環。同時最後一條clear指令會把自己給刪除，這樣畫面上就不會那麼礙眼。

;

底下要介紹的是userdata指令，讓我們可以傳遞一些資料給good，讓good根據這些資料產生不同的變化。

script StgeTest1
  speed(120)
  repeat(-1)
    direction(30, add)
    fire(sub1)
    sleep(0.1)
 end
end

script sub1
  sleep(rand(2,4))
  speed(120)
  userdata(1)
  repeat(10)
    direction(36, add)
    fire()
  end
end

如上，我們只在sub1裡加入一條userdata指令，參數傳入1。userdata最多可以傳遞4個參數，這裡我們只用了一個。那麼我們要怎麼應用？

現在我們回到StgeTest1.lua的Level.OnNewParticle事件，修改成如下程式碼。

Level.OnNewParticle = function(param, particle)
  local u1 = Stge.GetUserData(particle, 0)
  local obj = Good.GenObj(-1, -1)
  Good.SetDim(obj, 0,0, 8, 8)
  if (1 == u1) then
    Good.SetBgColor(obj, 0xff00ff00)
  else
    Good.SetBgColor(obj, 0xffff0000)
  end
  Stge.BindParticle(particle, obj)
end

如下所示，我們在一開始時透過Stge.GetUserData指令取得第一個參數(從0開始)，接著我們在設定色塊顏色時用這個參數來決定要用什麼顏色，在此例中，我們檢查如果是1就用綠色，否則就用紅色。所以執行結果，我們可以看到炸開的環都是綠色子彈！在實際應用上，我們可以自行利用這4個參數來作更多的變化。例如定義成粒子類形、hp、屬性等等。

;

現在再回到StgeTest1.stge，我們再修改一下原來的程式，如下所示。

script StgeTest1
  speed(120)
  repeat(-1)
    direction(30, add)
    fire(sub1, rand(2,4), 1)
    sleep(0.1)
  end
end

script sub1
  sleep($1)
  speed(120)
  userdata($2)
  repeat(10)
    direction(36, add)
    fire()
  end
  clear()
end

在這個範例裡面，我們把sub1要暫停的時間，和要設定的userdata參數化了，由在StgeTest1的fire指令參數傳遞過來給sub1(fire指令總共可以傳遞最多4個參數)。在sub1裡，就以$1及$2來取用由上一層傳遞過來的參數。透過這個方法，增加了不少彈性，可以作出更多的變化來。

;

範例程式下載