Log inGet started
Package

traversalKit.package

Newest version

This package holds more than this page lists. See all of its files in its world.

README.md

ClimbSurface (traversalKit)

Mark something climbable on purpose and say what kind of hold it is. Most surfaces need nothing: traversalKit climbs steep, tall, rough surfaces by rule. Use a marker for what the rule cannot see (a rope, a ladder, a bamboo pole too thin to have a face), to choose the hold kind, or to forbid climbing.

ladder.component.add("traversalKit.ClimbSurface", { kind = "ladder" })
glassTower.component.add("traversalKit.ClimbSurface", { climbable = false })
FieldDefault
kindstonestone, timber, tiles, rope, ladder, tree, cliff, bamboo: how it handles, sounds and is held
climbabletruetrue: always climbable; false: never (its ledges can still be grabbed and mantled). A rope is climbed by traversalKit's rope move along it, never as a wall, so climbKit is told it is not a wall.
tintfalsetint the Model with the kind's gallery colour (greyboxing)

It writes the climbable and climbKind attributes climbKit and traversalKit read, on every peer, and applies changes while running, so a level can swap a wall from stone to tiles with one field. It marks its entity and everything under it.