Repository navigation
docs: add the 1.10 guides - #21
Merged
Merged
Conversation
Which of teleport, fastTravel, travelToMap and travelToPlace to use and how each reports back, with travelToMap's levels option, the intro places and a player's own fast travel. Join and spawn points there for moving between maps, and the events table gains playerMapTravelComplete.
Covers player.moveTo, follow, stopMoving and moving, every walk option, owners, the playerMoveEnded reasons and how a walk's input hold sits beside client scripts' holds. Also covers seating the local player with LocalPlayer.anchor and its anchorReleased reasons, and resetFall for landing a scripted flight, with rows for both new events and an overview line.
LocalPlayer.stopPlayerInput now holds input per resource, and setJumpEnabled and setSprintEnabled switch off those two buttons with the same hold rules as the menu switches.
World.setSpawn and player.setSpawn for the connect load and for respawns without a position, how the two combine, and a /spawn teleport back to them. Spawn points are Overland positions with no map of their own. player.revive stands a dead player up where they lie, beside player.respawn, with when each applies and a revive-window sample.
A gear row's stats, giving gear a roll, keeping it over a rejoin, the server's gear stat multiplier and traits rules with their server.json keys, and LocalPlayer.gearStats on the client. playerInventoryUpdated also fires for gear and mounts the player changes in game, and the inventory still reads inside playerDisconnect.
Adds an animal forms section (setAnimalForm and getAnimalForm, and what changes for the player), a player collision section (World.setPlayerCollision and setCollidable), and the look's and creator's facial hair fields. Also notes that a hood toggle changes the look others see and that a full-mode resize keeps the feet on the ground.
A broom is drawn at its rider's setScale size with native flight collision, and setVisible(false) hides the broom or creature a hidden player rides.
Covers server-defined spells (Spells.define, get, list, remove), how a player gets and slots one, playerSpellCast, how PvP prices defined and modded spells with the moddedSpellCap rule, a Patronus summoned on cast, and resource-defined lessons through SpellLearning.define. Adds the playerSpellCast event row, the moddedSpellCap rule row, an overview line, links from the progression guide's spells and lessons sections, and points the hits guide's spell prices at the new guide.
Covers the 1.10 movement API: paths of waypoints for NPCs, beasts and characters, how each kind walks, holding and reading a path, what late joiners and new owners see, NPC idles and homes, beast follows, idles, areas and flight, and character speeds, facings and ground snapping. Adds the six waypoint and move-ended events to the runtime event table, an overview line, and a pointer from the NPCs guide.
Characters are no longer stationary humans: they walk server-authored paths, and Character.create accepts ghosts, house-elves, goblins, centaurs, crowd looks, busts, the Sorting Hat and the Howler, which spawn the game's own body. The guide, its overview line and the NPCs guide's link now say so, and point to the movement guide. An NPC or beast created with preferredOwnerId starts in that player's world and map.
Adds animation, material, motion, ttl, startFx, endFx and shrinkOut to the objects and effects guide, with streamRange and drawDistance, and a summoned stag that uses them. Physics and simulated objects now change simulator only once the change has held for 3 seconds.
Rewrites the virtual worlds guide for setVirtualWorld(world, map): an entity's world now combines with its map like a player's, and a preferredOwnerId starts an NPC or beast in that player's world and map. Adds the virtualWorld and map options of Lootables.place, Brewing.place, Herbology.place, Zone.create and Audio.playSoundAt, here and in the loot, zones and audio guides, and fixes what they said about worlds.
Covers running the train from the server through World.hogwartsExpress: positions and stops on the track, spawn, moveTo, depart, halt, despawn and get, the train events, who sees it across virtual worlds and maps, and the Foundations timetable in hmp-express. Adds the train events to the runtime event table and the guide to the overview.
Covers the client Shapes global: every shape type and option, colours, updating and removing shapes, following an entity, dropping a shape onto the ground, and drawing a zone's bounds or a line trace. Links the zones and line traces guides to it and adds it to the overview.
Covers the client AvatarPreview global: framing the player's live figure into a rect a web view reports, its options and state, how a preview ends, the page's half of the work, clips and framing, and what the backdrop and lighting can and cannot match.
Map markers gains the player's own waypoint: Blips.waypoint() and the waypointChanged event, with a party sharing waypoints. Camera gains Camera.getLookInput() for steering a script camera with the mouse. The client event table gains waypointChanged and mailRead.
Required CurseForge mods now cover what a join does since 1.9.0: updates to each project's latest file, the restart that applies mod changes, parked hand-placed mods, download progress, and what a rejected join names with what helps. Hosting a server notes which game copies players can use, with PC Game Pass marked experimental.
The castle door now appears for any player at it, and its walk-in is off by default. Doors and visits covers Sanctuary.setNativeEntry, the client's Sanctuary.door() fields, and a scripted prompt and entrance.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Guides for what changed in the mod from 1.9.0 to 1.10.0, one commit per guide or update.
New guides
travelToMap,travelToPlace, fast travel and refusing itplayer.moveTo/follow, seat anchors,resetFallSpells.define,playerSpellCast, PvP prices for defined and modded spells,SpellLearning.defineWorld.hogwartsExpress, the train events, and Foundations'hmp-expressAvatarPreviewUpdated
player.revive), Inventory (gear stats), Appearance (animal forms, facial hair, player collision), Brooms and mountsstreamRange,drawDistance), Loot, Zones and Audio in a map's worldsgetLookInput), and the events tableNote: the 1.10 contract declares
SpellDefinitionInput's andAvatarPreviewOptions' optional fields as required, so six samples are fencedjsxto skip type-checking until the mod marks them optional, as #20 did forDoors.set.Checked against the 1.10.0 contract merged with current main:
docs:check(224 samples),build,docs:links(57 pages) andgit diff --checkpass.