SketchyMaze
/
doodle
1
0
Fork 0
Code Issues 41 Pull Requests Releases Wiki Activity
doodle/pkg/uix/scripting.go

151 lines
4.2 KiB
Go
Raw Normal View History

Doodads: Use Key and Working Warp Doors * The "Use Key" (Q or Spacebar) now activates the Warp Door instead of a collision event doing so. * Warp Doors are now functional: the player opens a door, disappears, the door closes; player is teleported to the linked door which opens, appears the player and closes. * If the player exits thru a Blue or Orange door which is disabled (dotted outline), the door still opens and drops the player off but returns to a Disabled state, acting as a one-way door. * Clean up several debug log lines from Doodle and doodad scripts.
2021-01-03 23:19:21 +00:00
package uix
Update Doodad JS API + Hostile mobs New functions are available on the JavaScript API for doodads: * Actors.At(Point) []*Actor: returns actors intersecting a point * Actors.FindPlayer() *Actor: returns the nearest player character * Actors.New(filename string): create a new actor (NOT TESTED YET!) * Self.Grounded() bool: query the grounded status of current actor With this the game's built-in doodads have been revised: * Bird: will now scan 240 pixels diagonally searching for the player character and will dive if seen. The Bird is dangerous while diving. It will return to its original altitude once it touches the ground. * Azulians: the Azulians are now dangerous to player characters but not to the Thief. Azulians will begin to follow the player when they are within the aggro range and will hop if the player is above them to try and overcome obstacles. * Blue Azulian: aggro is (250, 100) jump speed 12 movement 2 * Red Azulian: aggro is (250, 200) jump speed 14 movement 4
2022-01-18 05:28:05 +00:00
import (
Rename Go module
2022-09-24 22:17:25 +00:00
"git.kirsle.net/SketchyMaze/doodle/pkg/doodads"
"git.kirsle.net/SketchyMaze/doodle/pkg/level"
"git.kirsle.net/SketchyMaze/doodle/pkg/log"
"git.kirsle.net/SketchyMaze/doodle/pkg/scripting"
Update Doodad JS API + Hostile mobs New functions are available on the JavaScript API for doodads: * Actors.At(Point) []*Actor: returns actors intersecting a point * Actors.FindPlayer() *Actor: returns the nearest player character * Actors.New(filename string): create a new actor (NOT TESTED YET!) * Self.Grounded() bool: query the grounded status of current actor With this the game's built-in doodads have been revised: * Bird: will now scan 240 pixels diagonally searching for the player character and will dive if seen. The Bird is dangerous while diving. It will return to its original altitude once it touches the ground. * Azulians: the Azulians are now dangerous to player characters but not to the Thief. Azulians will begin to follow the player when they are within the aggro range and will hop if the player is above them to try and overcome obstacles. * Blue Azulian: aggro is (250, 100) jump speed 12 movement 2 * Red Azulian: aggro is (250, 200) jump speed 14 movement 4
2022-01-18 05:28:05 +00:00
"git.kirsle.net/go/render"
)
Doodads: Electric Trapdoor and Resettable Box * New doodad: Electric Trapdoor. It is a horizontal version of the Electric Door. Opens while powered by a button or a switch and closes when it loses power. * The Box doodad will reset to its original location if it receives a power signal from a linked Button or Switch. So for box pushing puzzles you can add a reset button in case the boxes get stuck. * Refactored the Doodad build scripts into many Makefiles for easier iteration (don't need to compile ALL doodads to test one). Updates to the JavaScript API for doodads: * Self.MoveTo(Point) is now available to set the actor's position in world coordinates.
2021-08-09 03:10:42 +00:00
Doodads: Use Key and Working Warp Doors * The "Use Key" (Q or Spacebar) now activates the Warp Door instead of a collision event doing so. * Warp Doors are now functional: the player opens a door, disappears, the door closes; player is teleported to the linked door which opens, appears the player and closes. * If the player exits thru a Blue or Orange door which is disabled (dotted outline), the door still opens and drops the player off but returns to a Disabled state, acting as a one-way door. * Clean up several debug log lines from Doodle and doodad scripts.
2021-01-03 23:19:21 +00:00
// Functions relating to the Doodad JavaScript API for Canvas Actors.
Update Doodad JS API + Hostile mobs New functions are available on the JavaScript API for doodads: * Actors.At(Point) []*Actor: returns actors intersecting a point * Actors.FindPlayer() *Actor: returns the nearest player character * Actors.New(filename string): create a new actor (NOT TESTED YET!) * Self.Grounded() bool: query the grounded status of current actor With this the game's built-in doodads have been revised: * Bird: will now scan 240 pixels diagonally searching for the player character and will dive if seen. The Bird is dangerous while diving. It will return to its original altitude once it touches the ground. * Azulians: the Azulians are now dangerous to player characters but not to the Thief. Azulians will begin to follow the player when they are within the aggro range and will hop if the player is above them to try and overcome obstacles. * Blue Azulian: aggro is (250, 100) jump speed 12 movement 2 * Red Azulian: aggro is (250, 200) jump speed 14 movement 4
2022-01-18 05:28:05 +00:00
// MakeScriptAPI makes several useful globals available to doodad
// scripts such as Actors.At()
func (w *Canvas) MakeScriptAPI(vm *scripting.VM) {
vm.Set("Actors", map[string]interface{}{
// Actors.At(Point)
"At": func(p render.Point) []*Actor {
var result = []*Actor{}
for _, actor := range w.actors {
var box = actor.Hitbox().AddPoint(actor.Position())
if actor != nil && p.Inside(box) {
result = append(result, actor)
}
}
return result
},
// Actors.FindPlayer: returns the nearest player character.
"FindPlayer": func() *Actor {
for _, actor := range w.actors {
if actor.IsPlayer() {
return actor
}
}
return nil
},
// Actors.New: create a new actor.
"New": func(filename string) *Actor {
doodad, err := doodads.LoadFile(filename)
if err != nil {
panic(err)
}
actor := NewActor("_new", &level.Actor{}, doodad)
w.AddActor(actor)
// Set up the player character's script in the VM.
if err := w.scripting.AddLevelScript(actor.ID(), filename); err != nil {
log.Error("Actors.New(%s): scripting.InstallActor(player) failed: %s", filename, err)
}
return actor
},
Checkpoint Flag can Re-assign Player Character Link a Doodad to a Checkpoint Flag (like you would a Start Flag) and crossing the flag will replace the player with that doodad. Multiple checkpoint flags like this can toggle you between characters. * Azulians are now friendly to player characters who have the word "Azulian" in their title. * Improve Bird as the playable character: * Dive animation if the player flies diagonally downwards * Animation loop while hovering in the air instead of pausing * Checkpoint flags don't spam each other on PubSub so much which could sometimes lead to deadlocks! SetPlayerCharacter added to the JavaScript API. The Checkpoint Flag (not the region) can link to a doodad and replace the player character with that linked doodad when you activate the checkpoint: Actors.SetPlayerCharacter(filename string): like "boy.doodad" Add various panic catchers to make JavaScript safer and log issues to console.
2022-01-19 05:24:36 +00:00
// Actors.SetPlayerCharacter: remake the player character.
"SetPlayerCharacter": func(filename string) {
if w.OnSetPlayerCharacter != nil {
w.OnSetPlayerCharacter(filename)
} else {
log.Error("Actors.SetPlayerCharacter: caller was not ready")
}
},
Update Doodad JS API + Hostile mobs New functions are available on the JavaScript API for doodads: * Actors.At(Point) []*Actor: returns actors intersecting a point * Actors.FindPlayer() *Actor: returns the nearest player character * Actors.New(filename string): create a new actor (NOT TESTED YET!) * Self.Grounded() bool: query the grounded status of current actor With this the game's built-in doodads have been revised: * Bird: will now scan 240 pixels diagonally searching for the player character and will dive if seen. The Bird is dangerous while diving. It will return to its original altitude once it touches the ground. * Azulians: the Azulians are now dangerous to player characters but not to the Thief. Azulians will begin to follow the player when they are within the aggro range and will hop if the player is above them to try and overcome obstacles. * Blue Azulian: aggro is (250, 100) jump speed 12 movement 2 * Red Azulian: aggro is (250, 200) jump speed 14 movement 4
2022-01-18 05:28:05 +00:00
})
Level Difficulty + UI Polish Added a new level property: Difficulty * An enum ranging from -1, 0, 1 (Peaceful, Normal, Hard) * Default difficulty is Normal; pre-existing levels are Normal by default per the zero value. Doodad scripts can read the difficulty via the new global variable `Level.Difficulty` and some doodads have been updated: * Azulians: on Peaceful they ignore all player characters, and on Hard they are in "hunt mode": infinite aggro radius and they're aggressive to all characters. * Bird: on Peaceful they will not dive and attack any player character. Other spit and polish: * New Level/Level Properties UI reworked into a magicform. * New "PromptPre(question, answer, func)" function for prompting the user with the developer shell, but pre-filling in an answer for them to either post or edit. * magicform has a PromptUser field option for simple Text/Int fields which present as buttons, so magicform can prompt and update the variable itself. * Don't show the _autosave.doodad in the Doodad Dropper window.
2022-03-07 06:16:09 +00:00
vm.Set("Level", map[string]interface{}{
Flood Tool, Survival Mode for Azulian Tag New features: * Flood Tool for the editor. It replaces pixels of one color with another, contiguously. Has limits on how far from the original pixel it will color, to avoid infinite loops in case the user clicked on wide open void. The limit when clicking an existing color is 1200px or only a 600px limit if clicking into the void. * Cheat code: 'master key' to play locked Story Mode levels. Level GameRules feature added: * A new tab in the Level Properties dialog * Difficulty has been moved to this tab * Survival Mode: for silver high score, longest time alive is better than fastest time, for Azulian Tag maps. Gold high score is still based on fastest time - find the hidden level exit without dying! Tweaks to the Azulians' jump heights: * Blue Azulian: 12 -> 14 * Red Azulian: 14 -> 18 * White Azulian: 16 -> 20 Bugs fixed: * When editing your Palette to rename a color or add a new color, it wasn't possible to draw with that color until the editor was completely unloaded and reloaded; this is now fixed. * Minor bugfix in Difficulty.String() for Peaceful (-1) difficulty to avoid a negative array index. * Try and prevent user giving the same name to multiple swatches on their palette. Replacing the whole palette can let duplication through still.
2022-03-26 20:55:06 +00:00
"Difficulty": w.level.GameRule.Difficulty,
Reset Timer Doodad + Various Fixes * Bird is not solid when colliding with other birds. * If the dev shell is used to run JavaScript during Play Mode, consider it cheating (so player can't `$ d.Scene.ResetTimer()` for example) * On Survival Mode levels, DieByFire immediately opens the End Level (silver score) modal rather than respawn from checkpoint, so levels don't need checkpoint contraptions to end the level. * During level loading screens, wait and call doodads' main() function until the very end.
2022-03-27 18:51:14 +00:00
"ResetTimer": func() {
if w.OnResetTimer != nil {
w.OnResetTimer()
} else {
log.Error("Level.ResetTimer: caller was not ready")
}
},
Level Difficulty + UI Polish Added a new level property: Difficulty * An enum ranging from -1, 0, 1 (Peaceful, Normal, Hard) * Default difficulty is Normal; pre-existing levels are Normal by default per the zero value. Doodad scripts can read the difficulty via the new global variable `Level.Difficulty` and some doodads have been updated: * Azulians: on Peaceful they ignore all player characters, and on Hard they are in "hunt mode": infinite aggro radius and they're aggressive to all characters. * Bird: on Peaceful they will not dive and attack any player character. Other spit and polish: * New Level/Level Properties UI reworked into a magicform. * New "PromptPre(question, answer, func)" function for prompting the user with the developer shell, but pre-filling in an answer for them to either post or edit. * magicform has a PromptUser field option for simple Text/Int fields which present as buttons, so magicform can prompt and update the variable itself. * Don't show the _autosave.doodad in the Doodad Dropper window.
2022-03-07 06:16:09 +00:00
})
Update Doodad JS API + Hostile mobs New functions are available on the JavaScript API for doodads: * Actors.At(Point) []*Actor: returns actors intersecting a point * Actors.FindPlayer() *Actor: returns the nearest player character * Actors.New(filename string): create a new actor (NOT TESTED YET!) * Self.Grounded() bool: query the grounded status of current actor With this the game's built-in doodads have been revised: * Bird: will now scan 240 pixels diagonally searching for the player character and will dive if seen. The Bird is dangerous while diving. It will return to its original altitude once it touches the ground. * Azulians: the Azulians are now dangerous to player characters but not to the Thief. Azulians will begin to follow the player when they are within the aggro range and will hop if the player is above them to try and overcome obstacles. * Blue Azulian: aggro is (250, 100) jump speed 12 movement 2 * Red Azulian: aggro is (250, 200) jump speed 14 movement 4
2022-01-18 05:28:05 +00:00
}
Doodads: Use Key and Working Warp Doors * The "Use Key" (Q or Spacebar) now activates the Warp Door instead of a collision event doing so. * Warp Doors are now functional: the player opens a door, disappears, the door closes; player is teleported to the linked door which opens, appears the player and closes. * If the player exits thru a Blue or Orange door which is disabled (dotted outline), the door still opens and drops the player off but returns to a Disabled state, acting as a one-way door. * Clean up several debug log lines from Doodle and doodad scripts.
2021-01-03 23:19:21 +00:00
// MakeSelfAPI generates the `Self` object for the scripting API in
// reference to a live Canvas actor in the level.
func (w *Canvas) MakeSelfAPI(actor *Actor) map[string]interface{} {
return map[string]interface{}{
"Filename": actor.Doodad().Filename,
"Title": actor.Doodad().Title,
// functions
Generic Doodad Script Selection In the Doodad Properties window, instead of browsing to select a .js file to install your script, a SelectBox of built-in generic scripts are available. These scripts implement simple behaviors and adapt to the full canvas size of the doodad. Built-in scripts so far include: * generic-anvil.js: behaves just like the Anvil. * generic-fire.js: the entire canvas hitbox acts like fire pixels, "burning" mobile doodads and failing the level for the player. * generic-solid.js: the entire canvas hitbox acts solid
2021-09-03 05:33:28 +00:00
"ID": actor.ID,
"Size": func() render.Rect {
var size = actor.Doodad().ChunkSize()
return render.NewRect(size, size)
},
Doodad/Actor Runtime Options * Add "Options" support for Doodads: these allow for individual Actor instances on your level to customize properties about the doodad. They're like "Tags" except the player can customize them on a per-actor basis. * Doodad Editor: you can specify the Options in the Doodad Properties window. * Level Editor: when the Actor Tool is selected, on mouse-over of an actor, clicking on the gear icon will open a new "Actor Properties" window which shows metadata (title, author, ID, position) and an Options tab to configure the actor's options. Updates to the scripting API: * Self.Options() returns a list of option names defined on the Doodad. * Self.GetOption(name) returns the value for the named option, or nil if neither the actor nor its doodad have the option defined. The return type will be correctly a string, boolean or integer type. Updates to the doodad command-line tool: * `doodad show` will print the Options on a .doodad file and, when showing a .level file with --actors, prints any customized Options with the actors. * `doodad edit-doodad` adds a --option parameter to define options. Options added to the game's built-in doodads: * Warp Doors: "locked (exit only)" will make it so the door can not be opened by the player, giving the "locked" message (as if it had no linked door), but the player may still exit from the door if sent by another warp door. * Electric Door & Electric Trapdoor: "opened" can make the door be opened by default when the level begins instead of closed. A switch or a button that removes power will close the door as normal. * Colored Doors & Small Key Door: "unlocked" will make the door unlocked at level start, not requiring a key to open it. * Colored Keys & Small Key: "has gravity" will make the key subject to gravity and set its Mobile flag so that if it falls onto a button, it will activate. * Gemstones: they had gravity by default; you can now uncheck "has gravity" to remove their Gravity and IsMobile status. * Gemstone Totems: "has gemstone" will set the totem to its unlocked status by default with the gemstone inserted. No power signal will be emitted; it is cosmetic only. * Fire Region: "name" can let you set a name for the fire region similarly to names for fire pixels: "Watch out for ${name}!" * Invisible Warp Door: "locked (exit only)" added as well.
2022-10-10 00:41:24 +00:00
"GetTag": actor.Doodad().Tag,
"Options": actor.Options,
"GetOption": func(name string) interface{} {
opt := actor.GetOption(name)
if opt == nil {
return nil
}
return opt.Value
},
Doodads: Electric Trapdoor and Resettable Box * New doodad: Electric Trapdoor. It is a horizontal version of the Electric Door. Opens while powered by a button or a switch and closes when it loses power. * The Box doodad will reset to its original location if it receives a power signal from a linked Button or Switch. So for box pushing puzzles you can add a reset button in case the boxes get stuck. * Refactored the Doodad build scripts into many Makefiles for easier iteration (don't need to compile ALL doodads to test one). Updates to the JavaScript API for doodads: * Self.MoveTo(Point) is now available to set the actor's position in world coordinates.
2021-08-09 03:10:42 +00:00
"Position": actor.Position,
"MoveTo": func(p render.Point) {
actor.MoveTo(p)
actor.SetGrounded(false)
},
Invulnerable Anvil and other fixes * Add methods `Invulnerable() bool` and `SetInvulnerable(bool)` to the Actor API accessible in JavaScript (e.g. `Self.SetInvulnerable(true)`) * The Anvil is invulnerable - when played as, it can crush other mobs by jumping on them but is not defeated by those mobs at the same time. * Anvils don't destroy invulnerable mobs, such as other Anvils. * Bugfix: the Electric Door is considered to be opened from the first frame of animation when the door begins opening, and remains opened until the final frame of animation when it is closing. * New cheat code: `megaton weight` to play as the Anvil by default.
2022-02-20 19:48:36 +00:00
"Grounded": actor.Grounded,
"SetHitbox": actor.SetHitbox,
"Hitbox": actor.Hitbox,
"SetVelocity": actor.SetVelocity,
"GetVelocity": actor.Velocity,
"SetMobile": actor.SetMobile,
"SetInventory": actor.SetInventory,
"HasInventory": actor.HasInventory,
"SetGravity": actor.SetGravity,
"Invulnerable": actor.Invulnerable,
"SetInvulnerable": actor.SetInvulnerable,
"AddAnimation": actor.AddAnimation,
"IsAnimating": actor.IsAnimating,
"IsPlayer": actor.IsPlayer,
"PlayAnimation": actor.PlayAnimation,
"StopAnimation": actor.StopAnimation,
"ShowLayer": actor.ShowLayer,
"ShowLayerNamed": actor.ShowLayerNamed,
"Inventory": actor.Inventory,
"AddItem": actor.AddItem,
"RemoveItem": actor.RemoveItem,
"HasItem": actor.HasItem,
"ClearInventory": actor.ClearInventory,
"Destroy": actor.Destroy,
"Freeze": actor.Freeze,
"Unfreeze": actor.Unfreeze,
Swimming Physics and Bubble Pattern Water pixels finally do something other than turn your character blue! * When the player character is "wet" (touching water pixels, and so appearing in a blue mask), water physics apply: gravity is slower, your jump height is halved, but you get infinite jumps to swim higher in the water. * Holding the jump key under water will incur a short delay between jumps, so that you don't just fly straight up to the surface. Tap the jump button to move up quicker, you can spam it all you want. Azulians are also able to handle being under water: * They'll sink to the bottom and keep walking back and forth normally. * If you are above them and noticed, they'll jump (swim) up towards you, aware of the water and it jumps like you do. * The Blue Azulian has the poorest vertical aggro range so it isn't a very good swimmer. The White Azulian is very good at navigating water as it can pursue the player from the furthest distance of them all. Changes to the editor: * New brush pattern added: bubbles.png * It's the default pattern now for the "water" color of all of the built-in palettes instead of ink.png * A repeating pattern of bubbles carved out showing the level wallpaper. * The old "Bubbles (circles.png)" is renamed "Circles" * The last scroll position is saved with the Level file, so when you reload the level later it's scrolled at where you left it.
2022-05-06 04:35:32 +00:00
"IsWet": actor.IsWet,
Invulnerable Anvil and other fixes * Add methods `Invulnerable() bool` and `SetInvulnerable(bool)` to the Actor API accessible in JavaScript (e.g. `Self.SetInvulnerable(true)`) * The Anvil is invulnerable - when played as, it can crush other mobs by jumping on them but is not defeated by those mobs at the same time. * Anvils don't destroy invulnerable mobs, such as other Anvils. * Bugfix: the Electric Door is considered to be opened from the first frame of animation when the door begins opening, and remains opened until the final frame of animation when it is closing. * New cheat code: `megaton weight` to play as the Anvil by default.
2022-02-20 19:48:36 +00:00
"Hide": actor.Hide,
"Show": actor.Show,
Doodads: Use Key and Working Warp Doors * The "Use Key" (Q or Spacebar) now activates the Warp Door instead of a collision event doing so. * Warp Doors are now functional: the player opens a door, disappears, the door closes; player is teleported to the linked door which opens, appears the player and closes. * If the player exits thru a Blue or Orange door which is disabled (dotted outline), the door still opens and drops the player off but returns to a Disabled state, acting as a one-way door. * Clean up several debug log lines from Doodle and doodad scripts.
2021-01-03 23:19:21 +00:00
"GetLinks": func() []map[string]interface{} {
var result = []map[string]interface{}{}
for _, linked := range w.GetLinkedActors(actor) {
result = append(result, w.MakeSelfAPI(linked))
}
return result
},
"Look At Me" for Doodad Scripts * New script API method: Self.CameraFollowMe() to draw camera focus toward your doodad (it sets the Canvas.FollowActor target.) * The camera will go back to following the player on any action inputs (arrow keys, jump, use, etc.); if the player is constantly on the move the camera stays on him even if another actor is trying to take the focus. * The first few ticks of Play Mode the player character is always followed, to allow for Anvils to settle into place without taking the focus. * Canvas FollowActor: if the actor is 4 times the max scroll speed away, allow scrolling in greater leaps of 4 times the max scroll speed. New and Changed Doodads * Anvils will take the camera focus while they are falling. * New doodad: "Look At Me" - a 'camera region' technical doodad. Link it to any power source such as a Button - when this doodad receives power it will take the camera focus for a few frames. Use it to highlight a door that opened far off screen by linking the Button to both an Electric Door and a "Look At Me" near the door.
2022-09-25 06:54:51 +00:00
// Attract the camera's attention.
"CameraFollowMe": func() {
// Update the doodad that the camera should focus on.
w.FollowActor = actor.ID()
},
Doodads: Use Key and Working Warp Doors * The "Use Key" (Q or Spacebar) now activates the Warp Door instead of a collision event doing so. * Warp Doors are now functional: the player opens a door, disappears, the door closes; player is teleported to the linked door which opens, appears the player and closes. * If the player exits thru a Blue or Orange door which is disabled (dotted outline), the door still opens and drops the player off but returns to a Disabled state, acting as a one-way door. * Clean up several debug log lines from Doodle and doodad scripts.
2021-01-03 23:19:21 +00:00
}
}