Rpg Maker Developers Group

 A powerful camera tool that lets you:
 → Lock the camera on X or Y axis
 → Automatically scroll in a direction (like auto-run or platformer levels)
 → Trigger common events when reaching camera edges (during autoScroll)
 → Target an event, set camera position manually
 → Zoom in/out dynamically
 → Follow paths via regions

 Camera X/Y Lock
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 $gameSystem.setCameraLock(axis, lock, direction, loopJump, speed)
 axis      => "x" or "y"
 lock      => true or false => enables or disables lock
 direction => "left", "right" (for X), or "up", "down" (for Y)
 loopJump  => true/false    => if true, teleport player to opposite edge
 speed     => Number        => camera follow speed (default = 5)
 Notes:
 When direction is set to "both", the camera locks both directions
 on that axis.
 
 loopJump only works when direction is "both".
 Examples:
 $gameSystem.setCameraLock("x", true)               // Lock both X directions
 $gameSystem.setCameraLock("x", true, "left")       // Lock only left side of X
 $gameSystem.setCameraLock("x", true, "both", true) // Lock both and loop jump

 To unlock:
 $gameSystem.setCameraLock("x", false)
 $gameSystem.setCameraLock("x")                  // Equivalent to unlocking Y
 $gameSystem.resetCameraLock()                   // Unlock both "x" and "y"

 Automatic Scroll
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 $gameSystem.setAutoScroll(direction, speed)
 direction => "up", "down", "left", "right"
 speed     => Number - how fast the camera scrolls (default = 0.05)

 Notes:
 Triggers when the player hits the camera edge. The effect is defined
 in the plugin parameter as any JS code that returns "true".
 Example: SceneManager.push(Scene_Gameover)
 
 Higher speed number scrolls faster, lower number scrolls slower.
 
 Auto-scrolling stops automatically if the camera can't scroll further
 (i.e., reached the edge of the map).
 
 Auto-scroll in the Y direction (up/down) may also cause camera movement
 on the X axis. To prevent this, use $gameSystem.setCameraLock("x", true)
 to lock the camera horizontally.

 Example:
 $gameSystem.setAutoScroll("up")           // Scrolls "up" at speed 0.05
 $gameSystem.setAutoScroll("up", 0.02)     // Scrolls "up" slower
 $gameSystem.clearAutoScroll()             // Stop auto-scrolling


 Scroll to Target
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 Camera Sequence Script Call: $gameSystem.setCameraTo(steps)
 steps is an array of objects defining the camera movement sequence.

 Notes:
 The lock option only needs to be set once at the start of the sequence to
 lock player movement. Subsequent steps can omit it.

 The unlock option must be called at the end of the sequence (or during an event)
 to unlock player movement; omitting this will cause the game to freeze.

 Each step moves the camera based on the specified mode and parameters.

 The speed and wait parameters are optional; sensible defaults are used if omitted.

 Supported Modes and Options:

 mode: "static"  => Move camera to a fixed position.

 x: number (required)                  => target X coordinate
 y: number (required)                  => target Y coordinate
 lock: boolean (optional)              => lock player movement (only in first step)
 speed: number (optional, default 4)   => camera movement speed
 wait: number/string (optional)        => wait behavior (see below)


 mode: "event"  => Move camera to an event’s position.

 id: number (required) — event ID
 lock: boolean (optional)             => lock player movement (only in first step)
 speed: number (optional, default 4)  => camera movement speed
 wait: number/string (optional)       => wait behavior (see below)


 mode: "player"  => Focus camera on the player.

 unlock: boolean (optional, required at end) => unlock player movement
 speed: number (optional, default 4)         => camera movement speed
 wait: number/string (optional)              => wait behavior (see below)


 Wait Parameter Explanation:
 The wait parameter controls how the sequence progresses after the
 camera arrives at the target.

 Omitted or true    => Wait until arrival, then immediately continue to next step.
 false              => Same as above — no extra wait, continue immediately.
 Number (e.g., 60)  => Wait until arrival, then pause for given number of frames.
 String "true+N"    => Same as number — wait arrival plus N frames (for readability).

 Scriptcalls examples:
 $gameSystem.setCameraTo([
     {mode: "event", id: 1, lock: true, speed: 6, wait: true}
 ]);

 $gameSystem.setCameraTo([
     {mode: "event", id: 1, lock: true, speed: 6, wait: true},
     {mode: "player", speed: 4, wait: "true+60"},
     {mode: "event", id: 2, speed: 5, wait: 30},
     {mode: "static", x: 5, y: 5, speed: 3, wait: false},
     {mode: "static", x: 25, y: 15, speed: 6},
     {mode: "player", unlock: true}
 ]);

 Returning camera back to player
 You can also return the camera smoothly to the player position with:

 $gameMap.returnToPlayer(); // speed = 4
 $gameMap.returnToPlayer(speed); // adjust speed
 
 speed is optional; controls how fast the camera moves back to the player.


 Zoom in/out
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 [Planned feature]

 Implement zooming with stable centering.
 Support zoom-in above 100% (e.g., 150%-200%) and limited zoom-out
 below 100% (down to ~50%) where possible.
 Handle edge triggers and auto-scroll properly while zoomed.


 Scroll Path by Region
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 [Planned feature]

 Lock camera movement inside defined map regions.
 Prevent camera from moving outside specified region boundaries.
 Allow smooth zone transitions (like Zelda style screen shifts).
 Optionally integrate with auto-scroll for fun camera paths.

 Example Plugin Commands:
 ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞ ͞
 [Planned feature]
 Under construction