mirror of
https://github.com/codeninjasllc/codecombat.git
synced 2024-11-26 00:58:00 -05:00
70 lines
4.5 KiB
CoffeeScript
70 lines
4.5 KiB
CoffeeScript
c = require './common'
|
|
metaschema = require './metaschema'
|
|
|
|
attackSelfCode = """
|
|
class AttacksSelf extends Component
|
|
@className: "AttacksSelf"
|
|
chooseAction: ->
|
|
@attack @
|
|
"""
|
|
systems = ["action", "ai", "alliance", "collision", "combat", "display", "event", "existence", "hearing", "inventory", "movement", "programming", "targeting", "ui", "vision", "misc", "physics"]
|
|
|
|
PropertyDocumentationSchema = c.object {
|
|
title: "Property Documentation"
|
|
description: "Documentation entry for a property this Component will add to its Thang which other Components might want to also use."
|
|
"default":
|
|
name: "foo"
|
|
type: "object"
|
|
description: "This Component provides a 'foo' property to satisfy all one's foobar needs. Use it wisely."
|
|
required: ['name', 'type', 'description']
|
|
},
|
|
name: {type: 'string', pattern: c.identifierPattern, title: "Name", description: "Name of the property."}
|
|
type: c.shortString(title: "Type", description: "Intended type of the property.") # not actual JS types, just whatever they describe...
|
|
description: {type: 'string', description: "Description of the property.", maxLength: 1000}
|
|
args: c.array {title: "Arguments", description: "If this property has type 'function', then provide documentation for any function arguments."}, c.FunctionArgumentSchema
|
|
|
|
DependencySchema = c.object {
|
|
title: "Component Dependency"
|
|
description: "A Component upon which this Component depends."
|
|
"default":
|
|
#original: ?
|
|
majorVersion: 0
|
|
required: ["original", "majorVersion"]
|
|
format: 'latest-version-reference'
|
|
links: [{rel: "db", href: "/db/level.component/{(original)}/version/{(majorVersion)}"}]
|
|
},
|
|
original: c.objectId(title: "Original", description: "A reference to another Component upon which this Component depends.")
|
|
majorVersion: {title: "Major Version", description: "Which major version of the Component this Component needs.", type: 'integer', minimum: 0}
|
|
|
|
LevelComponentSchema = c.object {
|
|
title: "Component"
|
|
description: "A Component which can affect Thang behavior."
|
|
required: ["system", "name", "description", "code", "dependencies", "propertyDocumentation", "language"]
|
|
"default":
|
|
system: "ai"
|
|
name: "AttacksSelf"
|
|
description: "This Component makes the Thang attack itself."
|
|
code: attackSelfCode
|
|
language: "coffeescript"
|
|
dependencies: [] # TODO: should depend on something by default
|
|
propertyDocumentation: []
|
|
}
|
|
c.extendNamedProperties LevelComponentSchema # let's have the name be the first property
|
|
LevelComponentSchema.properties.name.pattern = c.classNamePattern
|
|
_.extend LevelComponentSchema.properties,
|
|
system: {title: "System", description: "The short name of the System this Component belongs to, like \"ai\".", type: "string", "enum": systems, "default": "ai"}
|
|
description: {title: "Description", description: "A short explanation of what this Component does.", type: "string", maxLength: 2000, "default": "This Component makes the Thang attack itself."}
|
|
language: {type: "string", title: "Language", description: "Which programming language this Component is written in.", "enum": ["coffeescript"]}
|
|
code: {title: "Code", description: "The code for this Component, as a CoffeeScript class. TODO: add link to documentation for how to write these.", "default": attackSelfCode, type: "string", format: "coffee"}
|
|
js: {title: "JavaScript", description: "The transpiled JavaScript code for this Component", type: "string", format: "hidden"}
|
|
dependencies: c.array {title: "Dependencies", description: "An array of Components upon which this Component depends.", "default": [], uniqueItems: true}, DependencySchema
|
|
propertyDocumentation: c.array {title: "Property Documentation", description: "An array of documentation entries for each notable property this Component will add to its Thang which other Components might want to also use.", "default": []}, PropertyDocumentationSchema
|
|
configSchema: _.extend metaschema, {title: "Configuration Schema", description: "A schema for validating the arguments that can be passed to this Component as configuration.", default: {type: 'object', additionalProperties: false}}
|
|
official: {type: "boolean", title: "Official", description: "Whether this is an official CodeCombat Component.", "default": false}
|
|
|
|
c.extendBasicProperties LevelComponentSchema, 'level.component'
|
|
c.extendSearchableProperties LevelComponentSchema
|
|
c.extendVersionedProperties LevelComponentSchema, 'level.component'
|
|
c.extendPermissionsProperties LevelComponentSchema, 'level.component'
|
|
|
|
module.exports = LevelComponentSchema
|