cha0s/avocado-old
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: descriptions

Browse Source
This commit is contained in:
cha0s 2020-06-19 22:01:45 -05:00
parent b63f25d5bb
commit 83498542e5
20 changed files with 392 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
packages/entity/index.hooks.js
View File

@ -1,7 +1,9 @@
export function behaviorContextTypes() {
return {
entity: (entity) => (
Object.values(entity.allTraitInstances())
entity: (entity) => {
const traitTypes = !entity
? {}
: Object.values(entity.allTraitInstances())
.reduce(
(r, {constructor: {behaviorContextTypes, describeParams, describeState}}) => ({
...r,
@ -9,7 +11,19 @@ export function behaviorContextTypes() {
...describeParams(),
...describeState(),
}), {},
)
),
);
return {
...traitTypes,
invokeHook: {
type: 'object',
label: 'Invoke hook.',
args: [
['hook', {
type: 'string',
}],
],
},
};
},
};
}

10
packages/entity/traits/existent.trait.js
View File

@ -12,8 +12,16 @@ export default class Existent extends decorate(Trait) {
static behaviorContextTypes() {
return {
destroy: {
type: 'void',
label: 'Destroy',
},
destroyGently: {
type: 'void',
label: 'Kill? Then destroy',
},
transition: {
type: 'ticking-promise',
type: 'void',
label: 'Transition $1 for $2 seconds using $3.',
args: [
['props', {

9
packages/entity/traits/perishable.trait.js
View File

@ -13,6 +13,15 @@ export default class Perishable extends decorate(Trait) {
};
}
static describeParams() {
return {
ttl: {
type: 'number',
label: 'Time-to-live in seconds',
},
};
}
static type() {
return 'perishable';
}

4
packages/entity/traits/positioned.trait.js
View File

@ -19,6 +19,10 @@ export default class Positioned extends decorate(Trait) {
static behaviorContextTypes() {
return {
position: {
type: 'vector',
label: 'Position',
},
setPosition: {
type: 'void',
label: 'Set position to $1.',

26
packages/entity/traits/spawner.trait.js
View File

@ -15,6 +15,10 @@ export default class Spawner extends decorate(Trait) {
static behaviorContextTypes() {
return {
killAllChildren: {
type: 'void',
label: 'Kill all spawned children',
},
spawn: {
type: 'entity',
label: 'Spawn $1 with $2 extensions.',
@ -72,6 +76,15 @@ export default class Spawner extends decorate(Trait) {
};
}
static describeParams() {
return {
spawns: {
type: 'object',
label: 'Entities that may be spawned',
},
};
}
static defaultState() {
return {
isSpawning: true,
@ -79,6 +92,19 @@ export default class Spawner extends decorate(Trait) {
};
}
static describeState() {
return {
isSpawning: {
type: 'bool',
label: 'Is spawning',
},
maxSpawns: {
type: 'number',
label: 'Maximum concurrent spawns',
},
};
}
static type() {
return 'spawner';
}

18
packages/graphics/traits/pictured.trait.js
View File

@ -25,6 +25,24 @@ export default class Pictured extends decorate(Trait) {
};
}
static describeParams() {
return {
images: {
type: 'object',
label: 'Images',
},
};
}
static describeState() {
return {
currentImage: {
type: 'string',
label: 'Current image',
},
};
}
static type() {
return 'pictured';
}

9
packages/graphics/traits/primitive.trait.js
View File

@ -13,6 +13,15 @@ export default class Primitive extends decorate(Trait) {
};
}
static describeParams() {
return {
primitives: {
type: 'object',
label: 'Primitives',
},
};
}
static type() {
return 'primitive';
}

13
packages/graphics/traits/textual.trait.js
View File

@ -17,6 +17,19 @@ export default class Textual extends decorate(Trait) {
};
}
static describeState() {
return {
text: {
type: 'string',
label: 'Text',
},
textStyle: {
type: 'object',
label: 'Text style',
},
};
}
static type() {
return 'textual';
}

38
packages/graphics/traits/visible.trait.js
View File

@ -57,6 +57,44 @@ export default class Visible extends decorate(Trait) {
};
}
static describeParams() {
return {
filter: {
type: 'object',
label: 'Filter',
},
trackPosition: {
type: 'bool',
label: 'Track position',
},
};
}
static describeState() {
return {
isVisible: {
type: 'bool',
label: 'Is visible',
},
opacity: {
type: 'number',
label: 'Opacity',
},
rotation: {
type: 'number',
label: 'Rotation',
},
visibleScale: {
type: 'vector',
label: 'Scale',
},
zIndex: {
type: 'number',
label: 'Z index',
},
};
}
static type() {
return 'visible';
}

31
packages/physics/traits/collider.trait.js
View File

@ -75,6 +75,35 @@ export default class Collider extends decorate(Trait) {
}
}
static describeParams() {
return {
activeCollision: {
type: 'bool',
label: 'Actively check collisions',
},
collidesWithGroups: {
type: 'object',
label: 'Collides with groups',
},
collisionEndActions: {
type: 'actions',
label: 'Collision ending actions',
},
collisionStartActions: {
type: 'actions',
label: 'Collision starting actions',
},
collisionGroup: {
type: 'string',
label: 'Collision group',
},
isSensor: {
type: 'bool',
label: 'Is sensor',
},
};
}
static describeState() {
return {
isCheckingCollisions: {
@ -83,7 +112,7 @@ export default class Collider extends decorate(Trait) {
},
isColliding: {
type: 'bool',
label: 'Is colliding',
label: 'Is able to collide',
},
}
}

54
packages/physics/traits/emitted.trait.js
View File

@ -8,6 +8,15 @@ const decorate = compose(
export default class Emitted extends decorate(Trait) {
static behaviorContextTypes() {
return {
particle: {
type: 'particle',
label: 'Create particle.',
},
};
}
static defaultParams() {
return {
alpha: {
@ -35,6 +44,51 @@ export default class Emitted extends decorate(Trait) {
};
}
static describeParams() {
return {
alpha: {
type: 'object',
label: 'Alpha',
},
force: {
type: 'vector',
label: 'Force',
},
listed: {
type: 'bool',
label: 'Is listed',
},
mass: {
type: 'number',
label: 'Mass',
},
position: {
type: 'vector',
label: 'Position',
},
rotation: {
type: 'object',
label: 'Rotation',
},
scale: {
type: 'object',
label: 'Scale',
},
transient: {
type: 'bool',
label: 'Is transient',
},
ttl: {
type: 'number',
label: 'Time to live in seconds',
},
velocity: {
type: 'object',
label: 'Velocity',
},
};
}
static type() {
return 'emitted';
}

44
packages/physics/traits/emitter.trait.js
View File

@ -14,12 +14,56 @@ const decorate = compose(
export default class Emitter extends decorate(Trait) {
static behaviorContextTypes() {
return {
emitParticleEntity: {
type: 'entity',
label: 'Create particle.',
args: [
['entity', {
type: 'entity',
}],
],
},
emitParticleJson: {
type: 'stream',
label: 'Create particle.',
args: [
['json', {
type: 'object',
}],
],
},
emitParticle: {
type: 'stream',
label: 'Create particle.',
args: [
['key', {
type: 'string',
}],
['json', {
type: 'object',
}],
],
},
};
}
static defaultParams() {
return {
particles: {},
};
}
static describeParams() {
return {
particles: {
type: 'object',
label: 'Particles',
},
};
}
static type() {
return 'emitter';
}

23
packages/physics/traits/physical.trait.js
View File

@ -12,6 +12,29 @@ const decorate = compose(
export default class Physical extends decorate(Trait) {
static behaviorContextTypes() {
return {
applyForce: {
type: 'void',
label: 'Apply force.',
args: [
['force', {
type: 'vector',
}],
],
},
applyImpulse: {
type: 'void',
label: 'Apply impulse.',
args: [
['impulse', {
type: 'vector',
}],
],
},
};
}
static defaultState() {
return {
addedToPhysics: true,

9
packages/physics/traits/shaped.trait.js
View File

@ -15,6 +15,15 @@ export default class Shaped extends decorate(Trait) {
};
}
static describeParams() {
return {
shape: {
type: 'object',
label: 'Shape',
},
};
}
static type() {
return 'shaped';
}

18
packages/sound/traits/audible.trait.js
View File

@ -6,6 +6,15 @@ export default class Audible extends Trait {
static behaviorContextTypes() {
return {
hasSound: {
type: 'bool',
label: 'Has $1 sound',
args: [
['key', {
type: 'string',
}],
],
},
playSound: {
type: 'void',
label: 'Play the $1 sound.',
@ -24,6 +33,15 @@ export default class Audible extends Trait {
};
}
static describeParams() {
return {
sounds: {
type: 'object',
label: 'Sounds',
},
};
}
static type() {
return 'audible';
}

9
packages/timing/traits/animated.trait.js
View File

@ -30,6 +30,15 @@ export default class Animated extends decorate(Trait) {
};
}
static describeParams() {
return {
animations: {
type: 'object',
label: 'Animations',
},
};
}
static describeState() {
return {
isAnimating: {

9
packages/topdown/traits/followed.trait.js
View File

@ -10,6 +10,15 @@ export default class Followed extends Trait {
}
}
static describeParams() {
return {
viewSize: {
type: 'vector',
label: 'View size',
},
};
}
static type() {
return 'followed';
}

18
packages/topdown/traits/layered.trait.js
View File

@ -3,6 +3,24 @@ import {Vector} from '@avocado/math';
export default class Layered extends Trait {
static behaviorContextTypes() {
return {
removeFromLayer: {
type: 'void',
label: 'Remove from layer.',
},
setIntoLayer: {
type: 'void',
label: 'Set into layer $1.',
args: [
['layer', {
type: 'layer',
}],
],
},
};
}
static type() {
return 'layered';
}

18
packages/topdown/traits/roomed.trait.js
View File

@ -2,6 +2,24 @@ import {Trait} from '@avocado/entity';
export default class Roomed extends Trait {
static behaviorContextTypes() {
return {
detachFromRoom: {
type: 'void',
label: 'Remove from room.',
},
attachToRoom: {
type: 'void',
label: 'Set into room $1.',
args: [
['room', {
type: 'room',
}],
],
},
};
}
static type() {
return 'roomed';
}

9
packages/topdown/traits/tile-entity.trait.js
View File

@ -16,6 +16,15 @@ export default class TileEntity extends decorate(Trait) {
};
}
static describeState() {
return {
tileIndex: {
type: 'number',
label: 'Tile index',
},
};
}
static type() {
return 'tile-entity';
}