FutureMUDengine for living text worlds

FutureProg functions

spawnbodyinstance

Charactercomputer function, computer program, standard futureprog

Overload 1

Character spawnbodyinstance(Character owner, Number form, Location location, Text mode)
Available in
  • computer function
  • computer program
  • standard futureprog
Spawns a secondary body instance from one of a loaded character's owned dormant forms. The returned character is the new physical actor, or the function errors with a builder-facing reason.
ParameterTypeDescription
owner Character The character identity whose dormant form should become a secondary body instance.
form Number The form alias or body id to spawn.
location Location The location where the body instance should appear.
mode Text The spawn mode: passive, focusable, ai, npcai, or scriptai.

Overload 2

Character spawnbodyinstance(Character owner, Number form, Location location, Text mode, Boolean cloneInventory)
Available in
  • computer function
  • computer program
  • standard futureprog
Spawns a secondary body instance from one of a loaded character's owned dormant forms. The returned character is the new physical actor, or the function errors with a builder-facing reason.
ParameterTypeDescription
owner Character The character identity whose dormant form should become a secondary body instance.
form Number The form alias or body id to spawn.
location Location The location where the body instance should appear.
mode Text The spawn mode: passive, focusable, ai, npcai, or scriptai.
cloneInventory Boolean Whether to deep-copy the owner's current direct inventory onto the spawned body.

Overload 3

Character spawnbodyinstance(Character owner, Number form, Location location, Text mode, Boolean cloneInventory, Text ais)
Available in
  • computer function
  • computer program
  • standard futureprog
Spawns a secondary body instance from one of a loaded character's owned dormant forms. For ai/scriptai modes, the final text argument attaches ready AI routines by id or name.
ParameterTypeDescription
owner Character The character identity whose dormant form should become a secondary body instance.
form Number The form alias or body id to spawn.
location Location The location where the body instance should appear.
mode Text The spawn mode: passive, focusable, ai, npcai, or scriptai.
cloneInventory Boolean Whether to deep-copy the owner's current direct inventory onto the spawned body.
ais Text A comma, semicolon, or pipe separated list of AI ids or names to attach to a script-AI body instance.

Overload 4

Character spawnbodyinstance(Character owner, Text form, Location location, Text mode)
Available in
  • computer function
  • computer program
  • standard futureprog
Spawns a secondary body instance from one of a loaded character's owned dormant forms. The returned character is the new physical actor, or the function errors with a builder-facing reason.
ParameterTypeDescription
owner Character The character identity whose dormant form should become a secondary body instance.
form Text The form alias or body id to spawn.
location Location The location where the body instance should appear.
mode Text The spawn mode: passive, focusable, ai, npcai, or scriptai.

Overload 5

Character spawnbodyinstance(Character owner, Text form, Location location, Text mode, Boolean cloneInventory)
Available in
  • computer function
  • computer program
  • standard futureprog
Spawns a secondary body instance from one of a loaded character's owned dormant forms. The returned character is the new physical actor, or the function errors with a builder-facing reason.
ParameterTypeDescription
owner Character The character identity whose dormant form should become a secondary body instance.
form Text The form alias or body id to spawn.
location Location The location where the body instance should appear.
mode Text The spawn mode: passive, focusable, ai, npcai, or scriptai.
cloneInventory Boolean Whether to deep-copy the owner's current direct inventory onto the spawned body.

Overload 6

Character spawnbodyinstance(Character owner, Text form, Location location, Text mode, Boolean cloneInventory, Text ais)
Available in
  • computer function
  • computer program
  • standard futureprog
Spawns a secondary body instance from one of a loaded character's owned dormant forms. For ai/scriptai modes, the final text argument attaches ready AI routines by id or name.
ParameterTypeDescription
owner Character The character identity whose dormant form should become a secondary body instance.
form Text The form alias or body id to spawn.
location Location The location where the body instance should appear.
mode Text The spawn mode: passive, focusable, ai, npcai, or scriptai.
cloneInventory Boolean Whether to deep-copy the owner's current direct inventory onto the spawned body.
ais Text A comma, semicolon, or pipe separated list of AI ids or names to attach to a script-AI body instance.

← Back to FutureProg functions