x

Desc: Name

Popup text

XML Schema Documentation

Printer-friendly Version
XML Instance Representation:
[ Expand All | Collapse All ]

Schema Component Representation:
[ Expand All | Collapse All ]

Table of Contents

top

Schema Document Properties

Target Namespace http://ProjectMalmo.microsoft.com
Version 0.21
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition

Declared Namespaces

Prefix Namespace
Default namespace http://ProjectMalmo.microsoft.com
xml http://www.w3.org/XML/1998/namespace
jaxb http://java.sun.com/xml/ns/jaxb
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
top

Global Declarations

Element: About

Name About
Type Locally-defined complex type
Nillable no
Abstract no

Description of the mission.

XML Instance Representation
<About>
<Summary> xs:string </Summary> [1]
<Description> xs:string </Description> [0..1]
</About>
Schema Component Representation
top

Element: AgentHandlers

Name AgentHandlers
Type Locally-defined complex type
Nillable no
Abstract no

Defines the Mission Handlers block for an individual agent.

XML Instance Representation
<AgentHandlers>
Start All [1]
<ObservationFromRecentCommands> ... </ObservationFromRecentCommands> [0..1]
<ObservationFromHotBar> ... </ObservationFromHotBar> [0..1]
<ObservationFromFullStats> ... </ObservationFromFullStats> [0..1]
<ObservationFromFullInventory> ... </ObservationFromFullInventory> [0..1]
<ObservationFromSubgoalPositionList> ... </ObservationFromSubgoalPositionList> [0..1]
<ObservationFromGrid> ... </ObservationFromGrid> [0..1]
<ObservationFromDistance> ... </ObservationFromDistance> [0..1]
<ObservationFromDiscreteCell> ... </ObservationFromDiscreteCell> [0..1]
<ObservationFromChat> ... </ObservationFromChat> [0..1]
<ObservationFromNearbyEntities> ... </ObservationFromNearbyEntities> [0..1]
<ObservationFromRay> ... </ObservationFromRay> [0..1]
<ObservationFromTurnScheduler> ... </ObservationFromTurnScheduler> [0..1]
<VideoProducer> ... </VideoProducer> [0..1]
<RewardForTouchingBlockType> ... </RewardForTouchingBlockType> [0..1]
<RewardForSendingCommand> ... </RewardForSendingCommand> [0..1]
<RewardForSendingMatchingChatMessage> ... </RewardForSendingMatchingChatMessage> [0..1]
<RewardForCollectingItem> ... </RewardForCollectingItem> [0..1]
<RewardForDiscardingItem> ... </RewardForDiscardingItem> [0..1]
<RewardForReachingPosition> ... </RewardForReachingPosition> [0..1]
<RewardForMissionEnd> ... </RewardForMissionEnd> [0..1]
<RewardForStructureCopying> ... </RewardForStructureCopying> [0..1]
<RewardForTimeTaken> ... </RewardForTimeTaken> [0..1]
<RewardForCatchingMob> ... </RewardForCatchingMob> [0..1]
<ContinuousMovementCommands> ... </ContinuousMovementCommands> [0..1]
<AbsoluteMovementCommands> ... </AbsoluteMovementCommands> [0..1]
<DiscreteMovementCommands> ... </DiscreteMovementCommands> [0..1]
<InventoryCommands> ... </InventoryCommands> [0..1]
<ChatCommands> ... </ChatCommands> [0..1]
<SimpleCraftCommands> ... </SimpleCraftCommands> [0..1]
<MissionQuitCommands> ... </MissionQuitCommands> [0..1]
<TurnBasedCommands> ... </TurnBasedCommands> [0..1]
<AgentQuitFromTimeUp> ... </AgentQuitFromTimeUp> [0..1]
<AgentQuitFromReachingPosition> ... </AgentQuitFromReachingPosition> [0..1]
<AgentQuitFromTouchingBlockType> ... </AgentQuitFromTouchingBlockType> [0..1]
<AgentQuitFromCollectingItem> ... </AgentQuitFromCollectingItem> [0..1]
<AgentQuitFromReachingCommandQuota> ... </AgentQuitFromReachingCommandQuota> [0..1]
<AgentQuitFromCatchingMob> ... </AgentQuitFromCatchingMob> [0..1]
End All
</AgentHandlers>
Schema Component Representation
top

Element: AgentSection

Name AgentSection
Type Locally-defined complex type
Nillable no
Abstract no

Each agent is specified in one of these sections, detailing the way they experience the world and the actions they can perform to interact with it.

XML Instance Representation
<AgentSection
mode="GameMode [0..1]">
<Name> xs:string </Name> [1]
<AgentStart> ... </AgentStart> [1]
<AgentHandlers> ... </AgentHandlers> [1]
</AgentSection>
Schema Component Representation
top

Element: AgentStart

Name AgentStart
Type Locally-defined complex type
Nillable no
Abstract no

Defines the initial conditions of the player. This includes the location and the contents of their inventory.

XML Instance Representation
<AgentStart>
Start All [1]
<Placement> PosAndDirection </Placement> [0..1] ?
<Inventory> [0..1]
Start Choice [0..*]
<InventoryObject> ... </InventoryObject> [1]
End Choice
</Inventory>
End All
</AgentStart>
Schema Component Representation
top

Element: InventoryBlock

  • This element can be used wherever the following element is referenced:
Name InventoryBlock
Type Locally-defined complex type
Nillable no
Abstract no

Defines a block in the inventory - deprecated, use InventoryObject instead

XML Instance Representation
<InventoryBlock
slot="xs:int (0 <= value <= 39) [1]"
type="BlockOrItem [1]"
variant="Variation [0..1]"
colour="Colour [0..1]"
quantity="xs:int (1 <= value <= 64) [0..1]"/>
Schema Component Representation
top

Element: InventoryItem

  • This element can be used wherever the following element is referenced:
Name InventoryItem
Type Locally-defined complex type
Nillable no
Abstract no

Defines an item in the inventory - deprecated, use InventoryObject instead

XML Instance Representation
<InventoryItem
slot="xs:int (0 <= value <= 39) [1]"
type="BlockOrItem [1]"
variant="Variation [0..1]"
colour="Colour [0..1]"
quantity="xs:int (1 <= value <= 64) [0..1]"/>
Schema Component Representation
top

Element: InventoryObject

Name InventoryObject
Type InventoryObjectType
Nillable no
Abstract no

Defines an item or block in the inventory.

XML Instance Representation
<InventoryObject
slot="xs:int (0 <= value <= 39) [1]"
type="BlockOrItem [1]"
variant="Variation [0..1]"
colour="Colour [0..1]"
quantity="xs:int (1 <= value <= 64) [0..1]"/>
Schema Component Representation
top

Element: Mission

Name Mission
Type Locally-defined complex type
Nillable no
Abstract no

A mission definition has a description, a starting point and some kind of scoring system. It also defines the agents and roles involved.

XML Instance Representation
<Mission
SchemaVersion="xs:token [0..1]">
<About> ... </About> [1]
<ModSettings> ... </ModSettings> [0..1]
<ServerSection> ... </ServerSection> [1]
<AgentSection> ... </AgentSection> [1..*]
</Mission>
Schema Component Representation
top

Element: ModSettings

Name ModSettings
Type Locally-defined complex type
Nillable no
Abstract no

Settings here are independent of the mission but affect how it is run.

XML Instance Representation
<ModSettings>
Start All [1]
<MsPerTick> xs:int (value >= 1) </MsPerTick> [0..1] ?
<PrioritiseOffscreenRendering> xs:boolean </PrioritiseOffscreenRendering> [0..1] ?
End All
</ModSettings>
Schema Component Representation
top

Element: ServerHandlers

Name ServerHandlers
Type Locally-defined complex type
Nillable no
Abstract no

Defines the Mission Handlers block for the server.

XML Instance Representation
<ServerHandlers>
Start Choice [1]
<FlatWorldGenerator> ... </FlatWorldGenerator> [1]
<FileWorldGenerator> ... </FileWorldGenerator> [1]
<DefaultWorldGenerator> ... </DefaultWorldGenerator> [1]
End Choice
Start Choice [0..*]
<DrawingDecorator> ... </DrawingDecorator> [1]
<AnimationDecorator> ... </AnimationDecorator> [1]
<MazeDecorator> ... </MazeDecorator> [1]
<ClassroomDecorator> ... </ClassroomDecorator> [1]
<SnakeDecorator> ... </SnakeDecorator> [1]
<MovingTargetDecorator> ... </MovingTargetDecorator> [1]
<BuildBattleDecorator> ... </BuildBattleDecorator> [1]
End Choice
Start Choice [0..*]
<ServerQuitFromTimeUp> ... </ServerQuitFromTimeUp> [1]
<ServerQuitWhenAnyAgentFinishes> ... </ServerQuitWhenAnyAgentFinishes> [1]
End Choice
</ServerHandlers>
Schema Component Representation
top

Element: ServerInitialConditions

Name ServerInitialConditions
Type Locally-defined complex type
Nillable no
Abstract no

Defines the initial conditions of the world.

XML Instance Representation
<ServerInitialConditions>
Start All [1]
<Time> ... </Time> [0..1]
<Weather> ... </Weather> [0..1]
<AllowSpawning> xs:boolean </AllowSpawning> [0..1] ?
<AllowedMobs> list of: EntityTypes </AllowedMobs> [0..1] ?
End All
</ServerInitialConditions>
Schema Component Representation
top

Element: ServerSection

Name ServerSection
Type Locally-defined complex type
Nillable no
Abstract no

The Minecraft server stores the world and keeps track of the blocks that have changed. Each Minecraft client connects to the server when it needs to change blocks or ask what blocks are present, for example. With multi-agent missions there may be many clients, all connected to a single server.

Settings here affect the shared world that the clients experience.

XML Instance Representation
<ServerSection>
<ServerInitialConditions> ... </ServerInitialConditions> [0..1]
<ServerHandlers> ... </ServerHandlers> [1]
</ServerSection>
Schema Component Representation
top

Element: StartTime

Name StartTime
Type Locally-defined simple type
Nillable no
Abstract no

Specifies the time of day at the start of the mission, in thousandths of an hour.

0 = dawn

6000 = noon

18000 = midnight

Time in Minecraft travels (by default) 72 times faster than real-time. Thus a Minecraft day lasts 20 minutes.

XML Instance Representation
<StartTime> xs:int (0 <= value <= 23999) </StartTime>
Schema Component Representation
top

Element: Time

Name Time
Type Locally-defined complex type
Nillable no
Abstract no

Minecraft has a day-night cycle that affects the light levels and the appearance of hostile mobs.

XML Instance Representation
<Time>
Start All [1]
<StartTime> ... </StartTime> [0..1]
<AllowPassageOfTime> xs:boolean </AllowPassageOfTime> [0..1] ?
End All
</Time>
Schema Component Representation
top

Element: Weather

Name Weather
Type Locally-defined simple type
Nillable no
Abstract no
Default Value normal

Specifies the type of weather at the start of the mission.

"normal" = let Minecraft do what it normally does

"clear" = start with clear weather

"rain" = start with rain (or snow, in a cold biome)

"thunder" = start with thundery weather

XML Instance Representation
<Weather> xs:string (value comes from list: {'normal'|'clear'|'rain'|'thunder'}) </Weather>
Schema Component Representation
top

Global Definitions

Complex Type: InventoryObjectType

Super-types: None
Sub-types: None
Name InventoryObjectType
Abstract no
XML Instance Representation
<...
slot="xs:int (0 <= value <= 39) [1]"
type="BlockOrItem [1]"
variant="Variation [0..1]"
colour="Colour [0..1]"
quantity="xs:int (1 <= value <= 64) [0..1]"/>
Schema Component Representation
top

Model Group: AgentMissionHandlers

Name AgentMissionHandlers

Lists the available Mission Handlers for an agent. Each can only be used once.

Application Data

<jaxb:property name="AgentMissionHandlers"/>
XML Instance Representation
Start All [1]
<ObservationFromRecentCommands> ... </ObservationFromRecentCommands> [0..1]
<ObservationFromHotBar> ... </ObservationFromHotBar> [0..1]
<ObservationFromFullStats> ... </ObservationFromFullStats> [0..1]
<ObservationFromFullInventory> ... </ObservationFromFullInventory> [0..1]
<ObservationFromSubgoalPositionList> ... </ObservationFromSubgoalPositionList> [0..1]
<ObservationFromGrid> ... </ObservationFromGrid> [0..1]
<ObservationFromDistance> ... </ObservationFromDistance> [0..1]
<ObservationFromDiscreteCell> ... </ObservationFromDiscreteCell> [0..1]
<ObservationFromChat> ... </ObservationFromChat> [0..1]
<ObservationFromNearbyEntities> ... </ObservationFromNearbyEntities> [0..1]
<ObservationFromRay> ... </ObservationFromRay> [0..1]
<ObservationFromTurnScheduler> ... </ObservationFromTurnScheduler> [0..1]
<VideoProducer> ... </VideoProducer> [0..1]
<RewardForTouchingBlockType> ... </RewardForTouchingBlockType> [0..1]
<RewardForSendingCommand> ... </RewardForSendingCommand> [0..1]
<RewardForSendingMatchingChatMessage> ... </RewardForSendingMatchingChatMessage> [0..1]
<RewardForCollectingItem> ... </RewardForCollectingItem> [0..1]
<RewardForDiscardingItem> ... </RewardForDiscardingItem> [0..1]
<RewardForReachingPosition> ... </RewardForReachingPosition> [0..1]
<RewardForMissionEnd> ... </RewardForMissionEnd> [0..1]
<RewardForStructureCopying> ... </RewardForStructureCopying> [0..1]
<RewardForTimeTaken> ... </RewardForTimeTaken> [0..1]
<RewardForCatchingMob> ... </RewardForCatchingMob> [0..1]
<ContinuousMovementCommands> ... </ContinuousMovementCommands> [0..1]
<AbsoluteMovementCommands> ... </AbsoluteMovementCommands> [0..1]
<DiscreteMovementCommands> ... </DiscreteMovementCommands> [0..1]
<InventoryCommands> ... </InventoryCommands> [0..1]
<ChatCommands> ... </ChatCommands> [0..1]
<SimpleCraftCommands> ... </SimpleCraftCommands> [0..1]
<MissionQuitCommands> ... </MissionQuitCommands> [0..1]
<TurnBasedCommands> ... </TurnBasedCommands> [0..1]
<AgentQuitFromTimeUp> ... </AgentQuitFromTimeUp> [0..1]
<AgentQuitFromReachingPosition> ... </AgentQuitFromReachingPosition> [0..1]
<AgentQuitFromTouchingBlockType> ... </AgentQuitFromTouchingBlockType> [0..1]
<AgentQuitFromCollectingItem> ... </AgentQuitFromCollectingItem> [0..1]
<AgentQuitFromReachingCommandQuota> ... </AgentQuitFromReachingCommandQuota> [0..1]
<AgentQuitFromCatchingMob> ... </AgentQuitFromCatchingMob> [0..1]
End All
Schema Component Representation
top

Model Group: TurnBasedApplicableCommandHandlers

Name TurnBasedApplicableCommandHandlers

Lists the command handlers which are applicable to a turn-based scenario.

Application Data

<jaxb:property name="TurnBasedApplicableCommandHandlers"/>
XML Instance Representation
Start All [1]
<AbsoluteMovementCommands> ... </AbsoluteMovementCommands> [0..1]
<DiscreteMovementCommands> ... </DiscreteMovementCommands> [0..1]
<InventoryCommands> ... </InventoryCommands> [0..1]
<ChatCommands> ... </ChatCommands> [0..1]
<SimpleCraftCommands> ... </SimpleCraftCommands> [0..1]
<MissionQuitCommands> ... </MissionQuitCommands> [0..1]
End All
Schema Component Representation
top

Simple Type: GameMode

Super-types: xs:string < GameMode (by restriction)
Sub-types: None
Name GameMode
Content
  • Base XSD Type: string
  • value comes from list: {'Survival'|'Creative'|'Adventure'|'Spectator'}

In survival mode the player can be hurt and experience hunger and must collect blocks. In creative mode they can fly and have an infinite supply of blocks. In spectator mode the player cannot change anything and can fly through blocks.

Schema Component Representation
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia">
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top