Categories
Where the game takes or gives one of a few fixed words, each word is an item of a category, a value of its own. Every category is here, by its name: cat.Ease.quadratic, cat.Align.left, cat.Key.space. type(cat.Ease.quadratic) is "Ease", an item prints as it is written, and it is equal only to itself (a word in quotes is no item). cat.new makes categories of your own.
cat.newfunction
cat.new(names: list of string, name: string or nil): catMakes a category of your own: local weather = cat.new({ "sunny", "rainy", "stormy" }). weather.sunny is then an item of it: its type is weather, it prints as weather.sunny and it is equal only to itself, and weather.snowy is a mistake. A category takes the name of what it is given to (weather here); name says another.
| Value | Type | |
|---|---|---|
names | list of string | |
name | string or nil | May be left out. |
Gives: cat.
cat.Easevalue
How a glide speeds up and slows down: tween, thing:tween, player:teleport, and a teleporter's ease.
| Item | |
|---|---|
cat.Ease.bezier | A key's own curve, shaped by its handles in the editor. A glide with it goes at one speed. |
cat.Ease.linear | At one speed all the way. |
cat.Ease.constant | Stays put, then jumps to the end at once. |
cat.Ease.sinusoidal | Gently, as a swing moves. |
cat.Ease.quadratic | A little faster at its fast end. |
cat.Ease.cubic | Faster at its fast end than quadratic. |
cat.Ease.quartic | Faster still. |
cat.Ease.quintic | Faster still: nearly a jump. |
cat.Ease.exponential | Very slow, then very fast (or the other way round). |
cat.Ease.circular | Like a quarter of a circle. |
cat.Ease.back | Goes a little past the end, and comes back. |
cat.Ease.bounce | Bounces like a ball at its end. |
cat.Ease.elastic | Springs round its end like a rubber band. |
cat.Directionvalue
Which end of a glide its ease is at: tween, player:teleport, and a teleporter's direction.
| Item | |
|---|---|
cat.Direction.in | Ease in: it starts slow. |
cat.Direction.out | Ease out: it ends slow. |
cat.Direction.inAndOut | Ease in and out: slow at both ends. |
cat.Direction.automatic | A key's ease picks its own direction from the keys around it (keys only, not glides). |
cat.Kindvalue
What a thing is: what thing.kind and thing.type give, what things.new makes, and what a search asks for.
| Item | |
|---|---|
cat.Kind.object | A block or a decoration (thing.kind). |
cat.Kind.block | An object that is a block: touching it does what its effect says, such as hurt or block the way (thing.type). |
cat.Kind.decoration | An object that is a decoration: it hurts nothing (thing.type). |
cat.Kind.floor | A piece of floor. |
cat.Kind.text | A text. |
cat.Kind.group | A group. |
cat.Kind.hazard | In a search along a line or in an area: only what kills the character. |
cat.Kind.solid | In a search along a line or in an area: only what the character can't go through. |
cat.Kind.water | In world:nearest only: the nearest place with no floor. |
cat.Kind.any | In a search: a thing of any kind. |
cat.Keyvalue
A key, a finger on a touch screen or a controller's button: input.isDown takes one, and input.keyDown and input.keyUp give one. A key this list doesn't have comes as its name, a string.
| Item | |
|---|---|
cat.Key.a | |
cat.Key.b | |
cat.Key.c | |
cat.Key.d | |
cat.Key.e | |
cat.Key.f | |
cat.Key.g | |
cat.Key.h | |
cat.Key.i | |
cat.Key.j | |
cat.Key.k | |
cat.Key.l | |
cat.Key.m | |
cat.Key.n | |
cat.Key.o | |
cat.Key.p | |
cat.Key.q | |
cat.Key.r | |
cat.Key.s | |
cat.Key.t | |
cat.Key.u | |
cat.Key.v | |
cat.Key.w | |
cat.Key.x | |
cat.Key.y | |
cat.Key.z | |
cat.Key.zero | |
cat.Key.one | |
cat.Key.two | |
cat.Key.three | |
cat.Key.four | |
cat.Key.five | |
cat.Key.six | |
cat.Key.seven | |
cat.Key.eight | |
cat.Key.nine | |
cat.Key.space | |
cat.Key.enter | The Enter (Return) key. |
cat.Key.tab | |
cat.Key.backspace | |
cat.Key.delete | |
cat.Key.insert | |
cat.Key.home | |
cat.Key.end | |
cat.Key.pageUp | |
cat.Key.pageDown | |
cat.Key.up | The up arrow. |
cat.Key.down | The down arrow. |
cat.Key.left | The left arrow. |
cat.Key.right | The right arrow. |
cat.Key.capsLock | |
cat.Key.leftShift | |
cat.Key.rightShift | |
cat.Key.leftCtrl | |
cat.Key.rightCtrl | |
cat.Key.leftAlt | |
cat.Key.rightAlt | |
cat.Key.minus | The - key. |
cat.Key.equals | The = key. |
cat.Key.leftBracket | The [ key. |
cat.Key.rightBracket | The ] key. |
cat.Key.backslash | The backslash key, \. |
cat.Key.semicolon | The ; key. |
cat.Key.apostrophe | The ' key. |
cat.Key.grave | The key under Esc, left of 1. |
cat.Key.comma | The , key. |
cat.Key.period | The . key. |
cat.Key.slash | The / key. |
cat.Key.f1 | |
cat.Key.f2 | |
cat.Key.f3 | |
cat.Key.f4 | |
cat.Key.f5 | |
cat.Key.f6 | |
cat.Key.f7 | |
cat.Key.f8 | |
cat.Key.f9 | |
cat.Key.f10 | |
cat.Key.f11 | |
cat.Key.f12 | |
cat.Key.keypad0 | |
cat.Key.keypad1 | |
cat.Key.keypad2 | |
cat.Key.keypad3 | |
cat.Key.keypad4 | |
cat.Key.keypad5 | |
cat.Key.keypad6 | |
cat.Key.keypad7 | |
cat.Key.keypad8 | |
cat.Key.keypad9 | |
cat.Key.keypadEnter | |
cat.Key.keypadPlus | |
cat.Key.keypadMinus | |
cat.Key.keypadMultiply | |
cat.Key.keypadDivide | |
cat.Key.keypadPeriod | |
cat.Key.touch | A finger on a touch screen. |
cat.Key.touch2 | A second finger at the same time. |
cat.Key.touch3 | A third finger. |
cat.Key.touch4 | A fourth finger. |
cat.Key.touch5 | A fifth finger. |
cat.Key.padA | A controller's bottom button. |
cat.Key.padB | A controller's right button. |
cat.Key.padX | A controller's left button. |
cat.Key.padY | A controller's top button. |
cat.Key.padUp | |
cat.Key.padDown | |
cat.Key.padLeft | |
cat.Key.padRight | |
cat.Key.padLeftShoulder | |
cat.Key.padRightShoulder | |
cat.Key.padLeftTrigger | |
cat.Key.padRightTrigger | |
cat.Key.padLeftStick | The left stick, pressed in. |
cat.Key.padRightStick | The right stick, pressed in. |
cat.Key.padStart | |
cat.Key.padBack |
cat.MouseButtonvalue
A mouse button: input.isDown takes one, and input.mouseDown and input.mouseUp give one.
| Item | |
|---|---|
cat.MouseButton.left | |
cat.MouseButton.right | |
cat.MouseButton.middle | The middle button, or the wheel pressed. |
cat.CameraEffectvalue
A hit on the screen: camera:effect, and an object's camera effect.
| Item | |
|---|---|
cat.CameraEffect.pulse | The screen beats bigger for a moment. |
cat.CameraEffect.shake | The screen shakes. |
cat.CameraEffect.blur | The screen blurs. |
cat.CameraEffect.rgb | The screen's red, green and blue slide apart. |
cat.CameraEffect.flash | The screen lights up in a color (white unless you say). |
cat.Childvalue
A kind of child: thing:addChild, thing:removeChild and thing:hasChild.
| Item | |
|---|---|
cat.Child.follow | Moves toward the camera or the character, or along with it. |
cat.Child.lookAt | Turns its top to face the camera or the character. |
cat.Child.blur | Drawn blurred. |
cat.Child.proximityFade | Fades in or out by how near the character is. |
cat.Child.noHitbox | Nothing touches it: scenery. |
cat.Child.gradient | Colors it and fades it across. |
cat.Child.particles | Particles flow from it. |
cat.Child.picture | A picture drawn over it. (Its properties are under thing.picture.) |
cat.Child.effects | What is under it is shown changed: blurred, in blocks, in other colors. |
cat.Child.mask | Only a part of it shows. |
cat.Child.pathMask | Only a part of the path is there. |
cat.Child.blendMode | How it mixes with what is behind it. |
cat.Alignvalue
Which way a text's lines are set: thing.align.
| Item |
|---|
cat.Align.left |
cat.Align.center |
cat.Align.right |
cat.Fontvalue
A text's font: thing.font.
| Item | |
|---|---|
cat.Font.rounded | Round, friendly letters. |
cat.Font.headline | Tall, bold letters for titles. |
cat.Font.typewriter | Every letter as wide as the others. |
cat.TextAnimationvalue
How a text comes in and goes: thing.in.anim and thing.out.anim.
| Item | |
|---|---|
cat.TextAnimation.none | |
cat.TextAnimation.fade | |
cat.TextAnimation.pop | |
cat.TextAnimation.slideUp | Slides up. |
cat.TextAnimation.slideDown | Slides down. |
cat.TextAnimation.spin | |
cat.TextAnimation.type | Letter by letter, as if typed. |
cat.IdleAnimationvalue
What a text's letters do while it shows: thing.idle.
| Item |
|---|
cat.IdleAnimation.none |
cat.IdleAnimation.wave |
cat.IdleAnimation.shake |
cat.IdleAnimation.pulse |
cat.IdleAnimation.rainbow |
cat.HitboxShapevalue
The shape of what touches: thing.hitboxShape and player.hitboxShape.
| Item |
|---|
cat.HitboxShape.box |
cat.HitboxShape.circle |
cat.TouchEffectvalue
What touching an object does: thing.effect.
| Item | |
|---|---|
cat.TouchEffect.kill | The character dies. |
cat.TouchEffect.checkpoint | A checkpoint. |
cat.TouchEffect.camera | A camera effect. |
cat.TouchEffect.button | A button that sets off nodes. |
cat.TouchEffect.teleport | Sends the character somewhere else. |
cat.TouchEffect.solid | Blocks the character: it can't go through it. It never hurts. |
cat.ButtonModevalue
How a button works: thing.press.
| Item | |
|---|---|
cat.ButtonMode.hold | On while it is touched. |
cat.ButtonMode.toggle | On and off at each touch. |
cat.ButtonMode.once | On for good at the first touch. |
cat.MoveModevalue
How a Move child goes: thing.move.mode.
| Item | |
|---|---|
cat.MoveMode.pingPong | There and back, at one speed. |
cat.MoveMode.loop | There, then from the start again. |
cat.MoveMode.sine | There and back, slowing at each end. |
cat.Targetvalue
What a Follow, Look at or Proximity child goes by: thing.follow.target and the like.
| Item | |
|---|---|
cat.Target.player | The character. |
cat.Target.camera |
cat.FollowModevalue
How a Follow child follows: thing.follow.mode.
| Item | |
|---|---|
cat.FollowMode.toward | Moves toward it. |
cat.FollowMode.along | Moves along with it. |
cat.Axesvalue
Which ways a Follow child follows: thing.follow.axes.
| Item | |
|---|---|
cat.Axes.both | |
cat.Axes.x | Across only. |
cat.Axes.y | Up and down only. |
cat.ProximityModevalue
What a Proximity child does when the character comes near: thing.proximity.mode.
| Item | |
|---|---|
cat.ProximityMode.show | Shows it when near. |
cat.ProximityMode.hide | Hides it when near. |
cat.GradientShapevalue
A gradient's shape: thing.gradient.shape.
| Item | |
|---|---|
cat.GradientShape.linear | Along a line. |
cat.GradientShape.radial | Out from its middle. |
cat.GradientShape.sweep | Round its middle, like a clock's hand. |
cat.Spreadvalue
What a gradient does past its ends: thing.gradient.spread.
| Item | |
|---|---|
cat.Spread.hold | Its end colors go on. |
cat.Spread.repeat | It starts again. |
cat.Spread.mirror | It goes back the other way. |
cat.ParticleShapevalue
A particle's shape: thing.particles.shape.
| Item |
|---|
cat.ParticleShape.square |
cat.ParticleShape.circle |
cat.ParticleShape.sparkle |
cat.ParticleShape.ring |
cat.ParticleEndvalue
What particles do when their thing goes: thing.particles.end.
| Item | |
|---|---|
cat.ParticleEnd.finish | Particles already let go fly on. |
cat.ParticleEnd.cut | They go with it at once. |
cat.Aimvalue
Which way particles fly: thing.particles.aim.
| Item | |
|---|---|
cat.Aim.direction | The way its direction says. |
cat.Aim.outward | Away from its middle. |
cat.ParticleAreavalue
The shape particles are let go from: thing.particles.from.
| Item |
|---|
cat.ParticleArea.box |
cat.ParticleArea.oval |
cat.ParticleHitvalue
What particles do when they hit something they collide with: thing.particles.onHit.
| Item | |
|---|---|
cat.ParticleHit.bounce | They bounce off, keeping some of their speed (thing.particles.bounce). |
cat.ParticleHit.stick | They stay where they hit, for the rest of their life. |
cat.ParticleHit.vanish | They go at once. |
cat.Collisionvalue
What a particle hit: hit.kind, in thing.particleHit.
| Item | |
|---|---|
cat.Collision.water | The water's edge: particles that stay on the path. |
cat.Collision.path | The path's edge: particles that stay on the water. |
cat.Collision.blocks | A block: something that hurts the character, or a solid object. |
cat.Collision.custom | One of the things picked in the particles' Collisions list. |
cat.Themevalue
The theme's colors, as theme.water and the others name them. Given to a color property (thing.color = cat.Theme.water) it follows that color of the theme from then on. An item reads like the color it is now (cat.Theme.water.r, cat.Theme.water:toHex()), and color.theme(cat.Theme.water) gives that color as a color value.
| Item | |
|---|---|
cat.Theme.water | |
cat.Theme.floorA | The floor's first color. |
cat.Theme.floorB | The floor's second color. |
cat.Theme.block | |
cat.Theme.blockLight | The blocks' edge. |
cat.Theme.glow | |
cat.Theme.waterDeep | The water's deep color. |
cat.Theme.waterTops | The tops of the waves. |
cat.Theme.shadowColor | The path's shadow. |
cat.FramePlayvalue
How a picture's frames play: thing.picture.play, and thing.particles.play for particles made of a picture.
| Item | |
|---|---|
cat.FramePlay.loop | |
cat.FramePlay.pingPong | Forward, then back. |
cat.FramePlay.once | |
cat.FramePlay.onceBack | Once forward and once back (a picture only). |
cat.FramePlay.still | Stays on one frame (a picture only). |
cat.FramePlay.random | A frame at random for each particle (particles only). |
cat.PictureStartvalue
When a picture's frames start: thing.picture.start.
| Item | |
|---|---|
cat.PictureStart.music | With the song. |
cat.PictureStart.appear | When the thing appears. |
cat.PictureStart.touch | When the character touches it. |
cat.PictureStart.press | When the player presses. |
cat.PictureStart.logic | When a node or a script says (thing:play). |
cat.PictureFitvalue
How a picture fits its thing: thing.picture.fit.
| Item | |
|---|---|
cat.PictureFit.stretch | Stretched to the thing's size. |
cat.PictureFit.keep | Its own shape kept. |
cat.PictureFit.slice | Its edges kept, its middle stretched. |
cat.PictureFit.repeat | Tiled over the thing. |
cat.PitchModevalue
How a sound's pitch moves: the pitchMode option of sound.play and sound.loop, and playing.pitchMode. The song always keeps its speed.
| Item | |
|---|---|
cat.PitchMode.changeSpeed | Higher is quicker, lower is slower, like a tape (as sounds always were). |
cat.PitchMode.keepSpeed | Higher or lower, but just as long. |
cat.BlendModevalue
How something is blended with what is behind it: thing.blend.mode, and camera.noise.blend for the noise effect.
| Item | |
|---|---|
cat.BlendMode.normal | |
cat.BlendMode.dissolve | |
cat.BlendMode.darken | |
cat.BlendMode.multiply | |
cat.BlendMode.colorBurn | |
cat.BlendMode.linearBurn | |
cat.BlendMode.darkerColor | |
cat.BlendMode.lighten | |
cat.BlendMode.screen | |
cat.BlendMode.colorDodge | |
cat.BlendMode.add | |
cat.BlendMode.lighterColor | |
cat.BlendMode.reflect | |
cat.BlendMode.glow | |
cat.BlendMode.overlay | |
cat.BlendMode.softLight | |
cat.BlendMode.hardLight | |
cat.BlendMode.vividLight | |
cat.BlendMode.linearLight | |
cat.BlendMode.pinLight | |
cat.BlendMode.hardMix | |
cat.BlendMode.difference | |
cat.BlendMode.exclusion | |
cat.BlendMode.subtract | |
cat.BlendMode.divide | |
cat.BlendMode.negation | |
cat.BlendMode.xor | |
cat.BlendMode.hue | |
cat.BlendMode.saturation | |
cat.BlendMode.color | |
cat.BlendMode.luminosity | |
cat.BlendMode.grain | Like film grain (the noise effect only). |
cat.MaskKindvalue
What a mask hides by: thing.mask.kind.
| Item | |
|---|---|
cat.MaskKind.black | Hides where it is black. |
cat.MaskKind.white | Hides where it is white. |
cat.MaskKind.custom | Hides by the parts you pick. |
cat.MaskShapevalue
A mask's shape: thing.mask.shape.
| Item |
|---|
cat.MaskShape.rectangle |
cat.MaskShape.ellipse |
cat.MaskReadsvalue
What a mask reads of its picture: thing.mask.from.
| Item |
|---|
cat.MaskReads.brightness |
cat.MaskReads.alpha |
cat.DisplayStylevalue
How the RGB display effect draws: camera.display.style.
| Item |
|---|
cat.DisplayStyle.bars |
cat.DisplayStyle.stripes |
cat.DisplayStyle.dots |
cat.NoisePatternvalue
The noise effect's pattern: camera.noise.pattern.
| Item | |
|---|---|
cat.NoisePattern.grains | Fine grains, like film. |
cat.NoisePattern.perlin | Soft clouds. |
cat.MeltBehindvalue
What the melt effect leaves behind: camera.melt.behind.
| Item | |
|---|---|
cat.MeltBehind.picture | The picture as it was. |
cat.MeltBehind.color | A color. |
cat.MeltBehind.mirror | The picture, mirrored. |
cat.MeltBehind.edge | Its edge, drawn on. |
cat.FloorPatternvalue
The theme's floor pattern: theme.pattern.
| Item |
|---|
cat.FloorPattern.checker |
cat.FloorPattern.stripes |
cat.FloorPattern.dots |
cat.FloorPattern.plain |
cat.FloorPattern.fill |
cat.BlockStylevalue
How the theme draws blocks: theme.blockStyle.
| Item |
|---|
cat.BlockStyle.glow |
cat.BlockStyle.flat |
cat.BlockStyle.outline |
cat.BlockStyle.filled |
cat.Backgroundvalue
The theme's background: theme.background.
| Item | |
|---|---|
cat.Background.water | |
cat.Background.void | Nothing: an empty background. |