Header menu logo Nu

WorldImSim Module

ImSim API for the world.

Functions and values

Function or value Description

lens .= value

Full Usage: lens .= value

Parameters:
    lens : Lens<'a, 's>
    value : 'a

Returns: ArgImSim<'s>

Specifies a static ImSim argument.

lens : Lens<'a, 's>
value : 'a
Returns: ArgImSim<'s>

lens @= value

Full Usage: lens @= value

Parameters:
    lens : Lens<'a, 's>
    value : 'a

Returns: ArgImSim<'s>

Specifies a dynamic ImSim argument.

lens : Lens<'a, 's>
value : 'a
Returns: ArgImSim<'s>

Type extensions

Type extension Description

this.ReinitializingImSim

Full Usage: this.ReinitializingImSim

Parameters:
    () : unit

Returns: bool

Whether ImSim is reinitializing this frame (such as on a code reload).

Extended Type: World

() : unit
Returns: bool

this.ReinitializingImSim

Full Usage: this.ReinitializingImSim

Returns: bool

Whether ImSim is reinitializing this frame (such as on a code reload).

Extended Type: World

Returns: bool

World.beginAssociation name args world

Full Usage: World.beginAssociation name args world

Parameters:

Begin the ImSim declaration of associated gui entities with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.beginEntity name args world

Full Usage: World.beginEntity name args world

Parameters:

Begin the ImSim declaration of an entity with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.beginEntityFromFile name entityFilePath args world

Full Usage: World.beginEntityFromFile name entityFilePath args world

Parameters:
    name : string
    entityFilePath : string
    args : ArgImSim<'a> seq
    world : World

Begin the ImSim declaration of a entity read from the given file path with the given arguments. Note that changing the file path over time has no effect as only the first moment is used.

Extended Type: World

name : string
entityFilePath : string
args : ArgImSim<'a> seq
world : World

World.beginEntityPlus zero init name args world

Full Usage: World.beginEntityPlus zero init name args world

Parameters:
Returns: 'r

Begin the ImSim declaration of an entity with the given arguments.

Extended Type: World

zero : 'r
init : (('r -> 'r) -> World -> unit) -> Entity -> World -> unit
name : string
args : ArgImSim<Entity> seq
world : World
Returns: 'r

World.beginGame args world

Full Usage: World.beginGame args world

Parameters:

Begin the ImSim declaration of a game with the given arguments.

Extended Type: World

args : ArgImSim<'a> seq
world : World

World.beginGroup name args world

Full Usage: World.beginGroup name args world

Parameters:

Begin the ImSim declaration of a group with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Group> seq
world : World

World.beginGroupFromFile name groupFilePath args world

Full Usage: World.beginGroupFromFile name groupFilePath args world

Parameters:
    name : string
    groupFilePath : string
    args : ArgImSim<'a> seq
    world : World

Begin the ImSim declaration of a group read from the given file path with the given arguments. Note that changing the file path over time has no effect as only the first moment is used.

Extended Type: World

name : string
groupFilePath : string
args : ArgImSim<'a> seq
world : World

World.beginGroupPlus zero init name args world

Full Usage: World.beginGroupPlus zero init name args world

Parameters:
Returns: 'r

Begin the ImSim declaration of a group with the given arguments.

Extended Type: World

zero : 'r
init : (('r -> 'r) -> World -> unit) -> Group -> World -> unit
name : string
args : ArgImSim<Group> seq
world : World
Returns: 'r

World.beginPanel name args world

Full Usage: World.beginPanel name args world

Parameters:

ImSim declare the beginning of a panel with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doAnimatedBillboard name args world

Full Usage: World.doAnimatedBillboard name args world

Parameters:

ImSim declare an animated billboard with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doAnimatedModel name args world

Full Usage: World.doAnimatedModel name args world

Parameters:

ImSim declare a animated model with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doAnimatedSprite name args world

Full Usage: World.doAnimatedSprite name args world

Parameters:

ImSim declare an animated sprite with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doAssociation name args world

Full Usage: World.doAssociation name args world

Parameters:

ImSim declare an empty association of gui entities with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doBall2d name args world

Full Usage: World.doBall2d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 2d ball with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doBall3d name args world

Full Usage: World.doBall3d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 3d ball with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doBasicStaticBillboardEmitter name args world

Full Usage: World.doBasicStaticBillboardEmitter name args world

Parameters:

ImSim declare a basic static billboard emitter with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doBasicStaticSpriteEmitter name args world

Full Usage: World.doBasicStaticSpriteEmitter name args world

Parameters:

ImSim declare a basic static sprite emitter with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doBlock2d name args world

Full Usage: World.doBlock2d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 2d block with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doBlock3d name args world

Full Usage: World.doBlock3d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 3d block with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doBodyJoint3d name args world

Full Usage: World.doBodyJoint3d name args world

Parameters:
Returns: BodyJointId * FQueue<BodyEventData>

ImSim declare a 3d body joint with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyJointId * FQueue<BodyEventData>

World.doBox2d name args world

Full Usage: World.doBox2d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 2d box with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doBox3d name args world

Full Usage: World.doBox3d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 3d box with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doButton name args world

Full Usage: World.doButton name args world

Parameters:
Returns: bool

ImSim declare a button with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: bool

World.doCharacter2d name args world

Full Usage: World.doCharacter2d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 2d character with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doCharacter3d name args world

Full Usage: World.doCharacter3d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 3d character with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doEffect2d name args world

Full Usage: World.doEffect2d name args world

Parameters:

ImSim declare a 2d effect with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doEffect3d name args world

Full Usage: World.doEffect3d name args world

Parameters:

ImSim declare a 3d effect with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doEntity name args world

Full Usage: World.doEntity name args world

Parameters:

ImSim declare an entity with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doEntityFromFile name entityFilePath args world

Full Usage: World.doEntityFromFile name entityFilePath args world

Parameters:
    name : string
    entityFilePath : string
    args : ArgImSim<'a> seq
    world : World

ImSim declare an entity read from the given file path with the given arguments. Note that changing the file path over time has no effect as only the first moment is used.

Extended Type: World

name : string
entityFilePath : string
args : ArgImSim<'a> seq
world : World

World.doEntityPlus zero init name args world

Full Usage: World.doEntityPlus zero init name args world

Parameters:
Returns: 'r

ImSim declare an entity with the given arguments.

Extended Type: World

zero : 'r
init : (('r -> 'r) -> World -> unit) -> Entity -> World -> unit
name : string
args : ArgImSim<Entity> seq
world : World
Returns: 'r

World.doFeeler name args world

Full Usage: World.doFeeler name args world

Parameters:
Returns: bool * bool

ImSim declare a feeler with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: bool * bool

World.doFillBar name args world

Full Usage: World.doFillBar name args world

Parameters:

ImSim declare a fill bar with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doFps name args world

Full Usage: World.doFps name args world

Parameters:

ImSim declare an fps entity with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doLabel name args world

Full Usage: World.doLabel name args world

Parameters:

ImSim declare a label with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doLight3d name args world

Full Usage: World.doLight3d name args world

Parameters:

ImSim declare a 3d light with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doLightProbe3d name args world

Full Usage: World.doLightProbe3d name args world

Parameters:

ImSim declare a 3d light probe with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doLighting3dConfig name args world

Full Usage: World.doLighting3dConfig name args world

Parameters:

ImSim declare a 3d light config with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doNav3dConfig name args world

Full Usage: World.doNav3dConfig name args world

Parameters:

ImSim declare a 3d nav config with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doPanel name args world

Full Usage: World.doPanel name args world

Parameters:

ImSim declare a panel with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doRadioButton name args world

Full Usage: World.doRadioButton name args world

Parameters:
Returns: bool * bool

ImSim declare a radio button with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: bool * bool

World.doRigidModel name args world

Full Usage: World.doRigidModel name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a rigid model with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doRigidModelHierarchy name args world

Full Usage: World.doRigidModelHierarchy name args world

Parameters:

ImSim declare a rigid model hierarchy with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doRigidModelSurface name args world

Full Usage: World.doRigidModelSurface name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a rigid model surface with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doSensorModel name args world

Full Usage: World.doSensorModel name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a sensor model with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doSensorModelSurface name args world

Full Usage: World.doSensorModelSurface name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a sensor model surface with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doSkyBox name args world

Full Usage: World.doSkyBox name args world

Parameters:

ImSim declare a sky box with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doSphere2d name args world

Full Usage: World.doSphere2d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 2d sphere with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doSphere3d name args world

Full Usage: World.doSphere3d name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a 3d sphere with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doSpineSkeleton name args world

Full Usage: World.doSpineSkeleton name args world

Parameters:
Returns: FQueue<SpineSkeletonAnimationTriggerData>

ImSim declare a tile map with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: FQueue<SpineSkeletonAnimationTriggerData>

World.doStaticBillboard name args world

Full Usage: World.doStaticBillboard name args world

Parameters:

ImSim declare a static billboard with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doStaticModel name args world

Full Usage: World.doStaticModel name args world

Parameters:

ImSim declare a static model with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doStaticModelHierarchy name args world

Full Usage: World.doStaticModelHierarchy name args world

Parameters:

ImSim declare a static model hierarchy with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doStaticModelSurface name args world

Full Usage: World.doStaticModelSurface name args world

Parameters:

ImSim declare a static model surface with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doStaticSprite name args world

Full Usage: World.doStaticSprite name args world

Parameters:

ImSim declare a static sprite with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doSubscription name eventAddress world

Full Usage: World.doSubscription name eventAddress world

Parameters:
Returns: FQueue<'d>

ImSim subscribe to the given event address.

Extended Type: World

name : string
eventAddress : 'd Address
world : World
Returns: FQueue<'d>

World.doSubscriptionPlus mapResult name eventAddress world

Full Usage: World.doSubscriptionPlus mapResult name eventAddress world

Parameters:
    mapResult : 'd -> 'r
    name : string
    eventAddress : 'd Address
    world : World

Returns: FQueue<'r>

ImSim subscribe to the given event address with a user-defined result.

Extended Type: World

mapResult : 'd -> 'r
name : string
eventAddress : 'd Address
world : World
Returns: FQueue<'r>

World.doSubscriptionToBodyEvents name entity world

Full Usage: World.doSubscriptionToBodyEvents name entity world

Parameters:
Returns: FQueue<BodyEventData>

ImGui subscribe to the given entity's body events.

Extended Type: World

name : string
entity : Entity
world : World
Returns: FQueue<BodyEventData>

World.doSubscriptionToSelectionEvents name screen world

Full Usage: World.doSubscriptionToSelectionEvents name screen world

Parameters:
Returns: FQueue<SelectionEventData>

ImGui subscribe to the given screen's selection events.

Extended Type: World

name : string
screen : Screen
world : World
Returns: FQueue<SelectionEventData>

World.doTerrain name args world

Full Usage: World.doTerrain name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a terrain with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doText name args world

Full Usage: World.doText name args world

Parameters:

ImSim declare a text entity with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World

World.doTextBox name args world

Full Usage: World.doTextBox name args world

Parameters:
Returns: string * bool

ImSim declare a text box entity with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: string * bool

World.doTileMap name args world

Full Usage: World.doTileMap name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a tile map with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doTmxMap name args world

Full Usage: World.doTmxMap name args world

Parameters:
Returns: BodyId * FQueue<BodyEventData>

ImSim declare a user-defined tile map with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: BodyId * FQueue<BodyEventData>

World.doToggleButton name args world

Full Usage: World.doToggleButton name args world

Parameters:
Returns: bool * bool

ImSim declare a toggle button with the given arguments.

Extended Type: World

name : string
args : ArgImSim<Entity> seq
world : World
Returns: bool * bool

World.endAssociation world

Full Usage: World.endAssociation world

Parameters:

End the ImSim declaration of associated gui entities.

Extended Type: World

world : World

World.endEntity world

Full Usage: World.endEntity world

Parameters:

End the ImSim declaration of an entity.

Extended Type: World

world : World

World.endGame world

Full Usage: World.endGame world

Parameters:

End the ImSim declaration of a group with the given arguments.

Extended Type: World

world : World

World.endGroup world

Full Usage: World.endGroup world

Parameters:

End the ImSim declaration of a group.

Extended Type: World

world : World

World.endPanel world

Full Usage: World.endPanel world

Parameters:

ImSim declare the end of a panel.

Extended Type: World

world : World

World.getReinitializingImSim world

Full Usage: World.getReinitializingImSim world

Parameters:
Returns: bool

Whether ImSim is reinitializing this frame (such as on a code reload).

Extended Type: World

world : World
Returns: bool

World.initBodyResult mapResult entity world

Full Usage: World.initBodyResult mapResult entity world

Parameters:

TODO: document this!

Extended Type: World

mapResult : ('a -> FQueue<BodyEventData>) -> World -> unit
entity : Entity
world : World

World.initSpineSkeletonAnimationResult mapResult entity world

Full Usage: World.initSpineSkeletonAnimationResult mapResult entity world

Parameters:

TODO: document this!

Extended Type: World

mapResult : ('a -> FQueue<SpineSkeletonAnimationTriggerData>) -> World -> unit
entity : Entity
world : World

World.scopeEntity entity args world

Full Usage: World.scopeEntity entity args world

Parameters:

Make an entity the current ImSim context.

Extended Type: World

entity : Entity
args : ArgImSim<Entity> seq
world : World

World.scopeGame args world

Full Usage: World.scopeGame args world

Parameters:

Make the game the current ImSim context.

Extended Type: World

args : ArgImSim<Game> seq
world : World

World.scopeGroup group args world

Full Usage: World.scopeGroup group args world

Parameters:

Make a group the current ImSim context.

Extended Type: World

group : Group
args : ArgImSim<Group> seq
world : World

World.scopeScreen screen args world

Full Usage: World.scopeScreen screen args world

Parameters:

Make a screen the current ImSim context.

Extended Type: World

screen : Screen
args : ArgImSim<Screen> seq
world : World

World.scopeWorld world

Full Usage: World.scopeWorld world

Parameters:

Clear the current ImSim context.

Extended Type: World

world : World

Type something to start searching.