Blocking & non-blocking APIs uniformity

[nighca]

Goal

This is part of #337 and aimed to address

• Lack of non-blocking version for animation APIs, Offer non-blocking animation APIs #327

Adjustments

This issue proposes adjustments to current APIs:

• Time-consuming operations (including animate, play, etc.) default to blocking, with non-blocking versions provided.
• Non-blocking versions should have a "start" prefix.

Details

play

// play sound till end
func play(sound Sound)
func play(soundName string)
func play(sound Sound, options *PlayOptions)
func play(soundName string, options *PlayOptions)
// start playing sound & return immediately
func startPlay(sound Sound)
func startPlay(soundName string)
func startPlay(sound Sound, options *PlayOptions)
func startPlay(soundName string, options *PlayOptions)

animate

// play animation till end
func animate(name string)
// start playing animation & return immediately
func startAnimate(name string)

glide, step, turn, turnTo

These are considered high-level APIs, which are expected to be extended in the same way, while in the future.

broadcast

broadcast appears different because "waiting" should not be included in the "broadcast" process by default.

// do broadcast
func broadcast(msg string)
func broadcast(msg string, data interface{})
// do broadcast and wait until all activated scripts end
func broadcastAndWait(msg string)
func broadcastAndWait(msg string, data interface{})