Header menu logo Nu

Content Module

MMCC content declaration API.

Functions and values

Function or value Description

Content.animatedBillboard entityName definitions

Full Usage: Content.animatedBillboard entityName definitions

Parameters:
Returns: EntityContent

Describe an animated billboard with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.animatedModel entityName definitions

Full Usage: Content.animatedModel entityName definitions

Parameters:
Returns: EntityContent

Describe an animated model with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.animatedSprite entityName definitions

Full Usage: Content.animatedSprite entityName definitions

Parameters:
Returns: EntityContent

Describe an animated sprite with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.association entityName definitions content

Full Usage: Content.association entityName definitions content

Parameters:
Returns: EntityContent

Describe an association of gui entities with the given definitions and content.

entityName : string
definitions : DefinitionContent<Entity> seq
content : EntityContent seq
Returns: EntityContent

Content.ball2d entityName definitions

Full Usage: Content.ball2d entityName definitions

Parameters:
Returns: EntityContent

Describe a 2d ball with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.ball3d entityName definitions

Full Usage: Content.ball3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d ball with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.basicStaticBillboardEmitter entityName definitions

Full Usage: Content.basicStaticBillboardEmitter entityName definitions

Parameters:
Returns: EntityContent

Describe a basic static billboard emitter with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.basicStaticSpriteEmitter entityName definitions

Full Usage: Content.basicStaticSpriteEmitter entityName definitions

Parameters:
Returns: EntityContent

Describe a basic static sprite emitter with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.block2d entityName definitions

Full Usage: Content.block2d entityName definitions

Parameters:
Returns: EntityContent

Describe a 2d block with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.block3d entityName definitions

Full Usage: Content.block3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d block with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.bodyJoint2d entityName definitions

Full Usage: Content.bodyJoint2d entityName definitions

Parameters:
Returns: EntityContent

Describe a 2d body joint with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.bodyJoint3d entityName definitions

Full Usage: Content.bodyJoint3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d body joint with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.box2d entityName definitions

Full Usage: Content.box2d entityName definitions

Parameters:
Returns: EntityContent

Describe a 2d box with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.box3d entityName definitions

Full Usage: Content.box3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d box with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.button entityName definitions

Full Usage: Content.button entityName definitions

Parameters:
Returns: EntityContent

Describe a button with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.cache name value fn

Full Usage: Content.cache name value fn

Parameters:
    name : string
    value : 'v
    fn : 'v -> 'c

Returns: 'c

Cache named content. Name must be globally unique!

name : string
value : 'v
fn : 'v -> 'c
Returns: 'c

Content.character2d entityName definitions

Full Usage: Content.character2d entityName definitions

Parameters:
Returns: EntityContent

Describe a 2d character with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.character3d entityName definitions

Full Usage: Content.character3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d character with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.composite entityName definitions entities

Full Usage: Content.composite entityName definitions entities

Parameters:
Returns: EntityContent

Describe an entity with the given dispatcher type and definitions as well as its contained entities.

entityName : string
definitions : DefinitionContent<Entity> seq
entities : EntityContent seq
Returns: EntityContent

Content.compositeFromFile entityName filePath definitions entities

Full Usage: Content.compositeFromFile entityName filePath definitions entities

Parameters:
Returns: EntityContent

Describe an entity with the given dispatcher type and definitions as well as its contained entities.

entityName : string
filePath : string
definitions : DefinitionContent<Entity> seq
entities : EntityContent seq
Returns: EntityContent

Content.effect2d entityName definitions

Full Usage: Content.effect2d entityName definitions

Parameters:
Returns: EntityContent

Describe a 2d effect with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.effect3d entityName definitions

Full Usage: Content.effect3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d effect with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.entity entityName definitions

Full Usage: Content.entity entityName definitions

Parameters:
Returns: EntityContent

Describe an entity with the given dispatcher type and definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.entityFromFile entityName filePath definitions

Full Usage: Content.entityFromFile entityName filePath definitions

Parameters:
Returns: EntityContent

Describe an entity with the given dispatcher type and definitions.

entityName : string
filePath : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.feeler entityName definitions

Full Usage: Content.feeler entityName definitions

Parameters:
Returns: EntityContent

Describe a feeler with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.fillBar entityName definitions

Full Usage: Content.fillBar entityName definitions

Parameters:
Returns: EntityContent

Describe a fill bar with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.fps entityName definitions

Full Usage: Content.fps entityName definitions

Parameters:
Returns: EntityContent

Describe an fps entity with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.game gameName definitions screens

Full Usage: Content.game gameName definitions screens

Parameters:
Returns: GameContent

Describe a game with the given definitions as well as its contained simulants.

gameName : string
definitions : DefinitionContent<'a> seq
screens : ScreenContent seq
Returns: GameContent

Content.group groupName definitions entities

Full Usage: Content.group groupName definitions entities

Parameters:
Returns: GroupContent

Describe a group with the given dispatcher type and definitions as well as its contained entities.

groupName : string
definitions : DefinitionContent<Group> seq
entities : EntityContent seq
Returns: GroupContent

Content.groupFromFile groupName filePath definitions entities

Full Usage: Content.groupFromFile groupName filePath definitions entities

Parameters:
Returns: GroupContent

Describe a group and its contained entities loaded from the given file with the given definitions.

groupName : string
filePath : string
definitions : DefinitionContent<Group> seq
entities : EntityContent seq
Returns: GroupContent

Content.label entityName definitions

Full Usage: Content.label entityName definitions

Parameters:
Returns: EntityContent

Describe a label with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.light3d entityName definitions

Full Usage: Content.light3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d light with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.lightProbe3d entityName definitions

Full Usage: Content.lightProbe3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d light probe with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.lighting3dConfig entityName definitions

Full Usage: Content.lighting3dConfig entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d lighting configuration.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.nav3dConfig entityName definitions

Full Usage: Content.nav3dConfig entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d navigation configuration.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.panel entityName definitions content

Full Usage: Content.panel entityName definitions content

Parameters:
Returns: EntityContent

Describe a panel with the given definitions and content.

entityName : string
definitions : DefinitionContent<Entity> seq
content : EntityContent seq
Returns: EntityContent

Content.radioButton entityName definitions

Full Usage: Content.radioButton entityName definitions

Parameters:
Returns: EntityContent

Describe a radio button with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.rigidModel entityName definitions

Full Usage: Content.rigidModel entityName definitions

Parameters:
Returns: EntityContent

Describe a rigid model with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.rigidModelHierarchy entityName definitions

Full Usage: Content.rigidModelHierarchy entityName definitions

Parameters:
Returns: EntityContent

Describe a rigid model expanded into an entity hierarchy with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.rigidModelSurface entityName definitions

Full Usage: Content.rigidModelSurface entityName definitions

Parameters:
Returns: EntityContent

Describe a rigid model surface with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.screen screenName screenBehavior definitions groups

Full Usage: Content.screen screenName screenBehavior definitions groups

Parameters:
Returns: ScreenContent

Describe a screen with the given dispatcher type and definitions as well as its contained simulants.

screenName : string
screenBehavior : ScreenBehavior
definitions : DefinitionContent<Screen> seq
groups : GroupContent seq
Returns: ScreenContent

Content.screenWithGroupFromFile screenName screenBehavior groupFilePath definitions groups

Full Usage: Content.screenWithGroupFromFile screenName screenBehavior groupFilePath definitions groups

Parameters:
Returns: ScreenContent

Describe a screen with the given type and definitions with a group loaded from the given file.

screenName : string
screenBehavior : ScreenBehavior
groupFilePath : string
definitions : DefinitionContent<Screen> seq
groups : GroupContent seq
Returns: ScreenContent

Content.sensorModel entityName definitions

Full Usage: Content.sensorModel entityName definitions

Parameters:
Returns: EntityContent

Describe a sensor model with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.sensorModelSurface entityName definitions

Full Usage: Content.sensorModelSurface entityName definitions

Parameters:
Returns: EntityContent

Describe a sensor model surface with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.skyBox entityName definitions

Full Usage: Content.skyBox entityName definitions

Parameters:
Returns: EntityContent

Describe a sky box with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.sphere2d entityName definitions

Full Usage: Content.sphere2d entityName definitions

Parameters:
Returns: EntityContent

Describe a 2d sphere with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.sphere3d entityName definitions

Full Usage: Content.sphere3d entityName definitions

Parameters:
Returns: EntityContent

Describe a 3d sphere with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.spineSkeleton entityName definitions

Full Usage: Content.spineSkeleton entityName definitions

Parameters:
Returns: EntityContent

Describe a Spine skeleton with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.staticBillboard entityName definitions

Full Usage: Content.staticBillboard entityName definitions

Parameters:
Returns: EntityContent

Describe a static billboard with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.staticModel entityName definitions

Full Usage: Content.staticModel entityName definitions

Parameters:
Returns: EntityContent

Describe a static model with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.staticModelHierarchy entityName definitions

Full Usage: Content.staticModelHierarchy entityName definitions

Parameters:
Returns: EntityContent

Describe a static model expanded into an entity hierarchy with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.staticModelSurface entityName definitions

Full Usage: Content.staticModelSurface entityName definitions

Parameters:
Returns: EntityContent

Describe a static model surface with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.staticSprite entityName definitions

Full Usage: Content.staticSprite entityName definitions

Parameters:
Returns: EntityContent

Describe a static sprite with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.terrain entityName definitions

Full Usage: Content.terrain entityName definitions

Parameters:
Returns: EntityContent

Describe a terrain with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.text entityName definitions

Full Usage: Content.text entityName definitions

Parameters:
Returns: EntityContent

Describe a text entity with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.textBox entityName definitions

Full Usage: Content.textBox entityName definitions

Parameters:
Returns: EntityContent

Describe a text box entity with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.tileMap entityName definitions

Full Usage: Content.tileMap entityName definitions

Parameters:
Returns: EntityContent

Describe a tile map with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.tmxMap entityName definitions

Full Usage: Content.tmxMap entityName definitions

Parameters:
Returns: EntityContent

Describe a tmx map with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.toggleButton entityName definitions

Full Usage: Content.toggleButton entityName definitions

Parameters:
Returns: EntityContent

Describe a toggle button with the given definitions.

entityName : string
definitions : DefinitionContent<Entity> seq
Returns: EntityContent

Content.wipe ()

Full Usage: Content.wipe ()

Parameters:
    () : unit

Discard cached content.

() : unit

Type something to start searching.