User:Oggal/Sandbox - Revision history

Oggal: /* Sentient Functions */

2026-06-27T03:33:50Z

Sentient Functions

← Older revision		Revision as of 03:33, 27 June 2026
Line 450:		Line 450:
	\| sentientHasItemSpecific \|\| sentient,commodity,quality,empire,text \|\| Test if the sentient's gear contains a very specific commodity.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \|\| bool		\| sentientHasItemSpecific \|\| sentient,commodity,quality,empire,text \|\| Test if the sentient's gear contains a very specific commodity.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \|\| bool
	\|-		\|-
	\| sentientHengeCeremony \| sentient,ll \| Order a sentient to perform the henge ceremony, if a henge is found near 'll'. \| void \|		\| sentientHengeCeremony \|\| sentient,ll \|\| Order a sentient to perform the henge ceremony, if a henge is found near 'll'. \|\| void
	\| sentientItemMakePermanent \| sentient,commodity,quality,empire,text \| Makes permanent a specific item in the sentient's gear. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \| void \|		\|-
	\| sentientItemSetDropOnDeath \| sentient,int,commodity,quality,empire,text \| Sets the drop behavior of an item in a sentient's gear: 0=default random drop on death, 1=no drop, 2=always drop.<br><br>Arguments:<br>'int' is the new state. \| void \|		\| sentientItemMakePermanent \|\| sentient,commodity,quality,empire,text \|\| Makes permanent a specific item in the sentient's gear. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \|\| void
	\| sentientItemSetState \| sentient,int,commodity,quality,empire,text \| Sets the state of an item in a sentient's gear, such as the on/off state of a light or musical instrument. Nothing happens if the item does not support different states.<br><br>Arguments:<br>'int' is the new state. Valid values are in the range of 0 to 255. \| void \|		\|-
	\| sentientMoveAway \| sentient,atom,real,real \| Order a sentient to move away from 'atom'.<br><br>Arguments:<br>First 'real' is the distance to move in meters.<br>Second 'real' is the angle left or right from directly away in degrees. \| void \|		\| sentientItemSetDropOnDeath \|\| sentient,int,commodity,quality,empire,text \|\| Sets the drop behavior of an item in a sentient's gear: 0=default random drop on death, 1=no drop, 2=always drop.<br><br>Arguments:<br>'int' is the new state. \|\| void
	\| sentientMoveBack \| sentient,real \| Order a sentient to move backward a distance specified in meters. \| void \|		\|-
	\| sentientMoveClose \| sentient,atom,real \| Order a sentient to move close to atom, within a distance specified in meters. \| void \|		\| sentientItemSetState \|\| sentient,int,commodity,quality,empire,text \|\| Sets the state of an item in a sentient's gear, such as the on/off state of a light or musical instrument. Nothing happens if the item does not support different states.<br><br>Arguments:<br>'int' is the new state. Valid values are in the range of 0 to 255. \|\| void
	\| sentientMoveForward \| sentient,real \| Order a sentient to move forward a distance specified in meters. \| void \|		\|-
	\| sentientMoveToward \| sentient,atom,real \| Order a sentient to move toward 'atom'.<br><br>Arguments:<br>First 'real' is the distance to move in meters. Distance is truncated to the current distance to the atom.<br>Second 'real' is the angle left or right from directly toward in degrees. \| void \|		\| sentientMoveAway \|\| sentient,atom,real,real \|\| Order a sentient to move away from 'atom'.<br><br>Arguments:<br>First 'real' is the distance to move in meters.<br>Second 'real' is the angle left or right from directly away in degrees. \|\| void
	\| sentientOkToRun \| sentient,bool \| Sets whether a sentient is permitted to run to their destination. Default is yes. \| void \|		\|-
	\| sentientReload \| sentient,itemsub,commodity,quality,empire,text \| Order a sentient to reload their weapon. \| void \|		\| sentientMoveBack \|\| sentient,real \|\| Order a sentient to move backward a distance specified in meters. \|\| void
			\|-
			\| sentientMoveClose \|\| sentient,atom,real \|\| Order a sentient to move close to atom, within a distance specified in meters. \|\| void
			\|-
			\| sentientMoveForward \|\| sentient,real \|\| Order a sentient to move forward a distance specified in meters. \|\| void
			\|-
			\| sentientMoveToward \|\| sentient,atom,real \|\| Order a sentient to move toward 'atom'.<br><br>Arguments:<br>First 'real' is the distance to move in meters. Distance is truncated to the current distance to the atom.<br>Second 'real' is the angle left or right from directly toward in degrees. \|\| void
			\|-
			\| sentientOkToRun \|\| sentient,bool \|\| Sets whether a sentient is permitted to run to their destination. Default is yes. \|\| void
			\|-
			\| sentientReload \|\| sentient,itemsub,commodity,quality,empire,text \|\| Order a sentient to reload their weapon. \|\| void
			\|-
	\| sentientSay \|\| sentient,text,visage \|\| Order a sentient being to say a message on the Voice channel.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void		\| sentientSay \|\| sentient,text,visage \|\| Order a sentient being to say a message on the Voice channel.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\|-		\|-

Oggal: /* Sentient Functions */

2026-06-27T03:30:20Z

Sentient Functions

← Older revision		Revision as of 03:30, 27 June 2026
Line 461:		Line 461:
	\| sentientOkToRun \| sentient,bool \| Sets whether a sentient is permitted to run to their destination. Default is yes. \| void \|		\| sentientOkToRun \| sentient,bool \| Sets whether a sentient is permitted to run to their destination. Default is yes. \| void \|
	\| sentientReload \| sentient,itemsub,commodity,quality,empire,text \| Order a sentient to reload their weapon. \| void \|		\| sentientReload \| sentient,itemsub,commodity,quality,empire,text \| Order a sentient to reload their weapon. \| void \|
	\| sentientSay \| sentient,text,visage \| Order a sentient being to say a message on the Voice channel.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\| sentientSay \|\| sentient,text,visage \|\| Order a sentient being to say a message on the Voice channel.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\| sentientSayAudio \| sentient,file,text,visage \| Order a sentient to say a message on the Voice channel. The audio emits from the sentient.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\|-
	\| sentientSayChoice \| sentient,choiceValue,text,visage \| Order a sentient being to say a choice on the Voice channel. A choice message appears with a bright green asterisk.<br><br>Several choices may be stated if each is given a different choiceValue.<br><br>Result of player's choice is tested using the choiceMade function.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\| sentientSayAudio \|\| sentient,file,text,visage \|\| Order a sentient to say a message on the Voice channel. The audio emits from the sentient.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\| sentientSayImage \| sentient,file,text,text,visage \| Order a sentient to say a message on the Voice channel. The image appears automatically.<br><br>Arguments:<br>'text' args are image title and text to say.<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\|-
	\| sentientSayTo \| sentient,atom,text,visage \| Order a sentient being to say a message on the Voice channel to someone. They will turn to face them.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\| sentientSayChoice \|\| sentient,choiceValue,text,visage \|\| Order a sentient being to say a choice on the Voice channel. A choice message appears with a bright green asterisk.<br><br>Several choices may be stated if each is given a different choiceValue.<br><br>Result of player's choice is tested using the choiceMade function.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\| sentientSellGearItem \| sentient,atom,commodity,int \| Offers an item from a sentient's gear on the Voice channel.<br><br>Arguments:<br>'atom' is the target of the sale, causing sentient to turn to face them; it can be null.<br>The best Q 'commodity' possessed by 'sentient' is offered for sale.<br>'int' is the price, which can be 0 to offer it for free. \| void \|		\|-
	\| sentientSetPosture \| sentient,posture \| Order a sentient to assume a posture. \| void \|		\| sentientSayImage \|\| sentient,file,text,text,visage \|\| Order a sentient to say a message on the Voice channel. The image appears automatically.<br><br>Arguments:<br>'text' args are image title and text to say.<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\| sentientStay \| sentient \| Order a sentient to stay at their current location. \| void \|		\|-
			\| sentientSayTo \|\| sentient,atom,text,visage \|\| Order a sentient being to say a message on the Voice channel to someone. They will turn to face them.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
			\|-
			\| sentientSellGearItem \|\| sentient,atom,commodity,int \|\| Offers an item from a sentient's gear on the Voice channel.<br><br>Arguments:<br>'atom' is the target of the sale, causing sentient to turn to face them; it can be null.<br>The best Q 'commodity' possessed by 'sentient' is offered for sale.<br>'int' is the price, which can be 0 to offer it for free. \|\| void
			\|-
			\| sentientSetPosture \|\| sentient,posture \|\| Order a sentient to assume a posture. \|\| void
			\|-
			\| sentientStay \|\| sentient \|\| Order a sentient to stay at their current location. \|\| void
			\|-
			\|}
	---		---

Oggal: /* Sentient Functions */

2026-06-27T03:27:15Z

Sentient Functions

← Older revision		Revision as of 03:27, 27 June 2026
Line 409:		Line 409:

	Sentient functions operate on a specific sentient creature, which is the first argument of all sentient functions.		Sentient functions operate on a specific sentient creature, which is the first argument of all sentient functions.
			{\| class="wikitable"
	\| Method Name \| Inputs \| Description \| Return Type \|		\|+ Sentient Functions
	\|-~~--\|---\|---\|---\|~~		\|-
	\| sentientAttackUnit \| sentient,unit \| Order a sentient to attack a unit. \| void \|		! Method Name !! Inputs !! Description !! Return Type
	\| sentientClearGear \| sentient \| Removes all items of gear. \| void \|		\|-
	\| sentientCreateGear \| sentient,gearslot,bool,commodity,quality,empire,text \| Create an item in a sentient's gear.<br><br>Arguments:<br>'bool' is true to make the item permanent. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br>'empire' is the empire of origin of the item.<br>'text' is inscribed on the item if not blank. If the item is a blueprint disk or drawing, the inscription can be used to pass the blueprint id. \| void \|		\| sentientAttackUnit \|\| sentient,unit \|\| Order a sentient to attack a unit. \|\| void
	\| sentientDropGear \| sentient,gearslot \| Drops the item at a sentient's gear slot. \| item \|		\|-
	\| sentientDropGearItem \| sentient,commodity \| Drops an item from a sentient's gear. \| item \|		\| sentientClearGear \|\| sentient \|\| Removes all items of gear. \|\| void
	\| sentientFireWeapon \| sentient \| Order a sentient to fire their weapon in hand at nothing in particular. \| void \|		\|-
	\| sentientFollowAvatar \| sentient \| Order a sentient to follow the person. \| void \|		\| sentientCreateGear \|\| sentient,gearslot,bool,commodity,quality,empire,text \|\| Create an item in a sentient's gear.<br><br>Arguments:<br>'bool' is true to make the item permanent. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br>'empire' is the empire of origin of the item.<br>'text' is inscribed on the item if not blank. If the item is a blueprint disk or drawing, the inscription can be used to pass the blueprint id. \|\| void
	\| sentientFollowSentient \| sentient,sentient \| Order a sentient to follow another sentient. \| void \|		\|-
	\| sentientGetIn \| sentient,atom \| Sentient moves close enough then rides the unit. e.g. boards a vehicle or spacecraft or rides a horse. \| void \|		\| sentientDropGear \|\| sentient,gearslot \|\| Drops the item at a sentient's gear slot. \|\| item
	\| sentientGetItem \| sentient,item \| Order a sentient to pick an item up off the ground. \| void \|		\|-
	\| sentientGetOut \| sentient,atom \| Sentient gets out of an atom. Completed when atom is no longer their parent. If an active teleporter is present, they will get into it. \| void \|		\| sentientDropGearItem \|\| sentient,commodity \|\| Drops an item from a sentient's gear. \|\| item
	\| sentientGoToAvatar \| sentient \| Order a sentient to go to the avatar. \| void \|		\|-
	\| sentientGoToLL \| sentient,ll \| Order a sentient to go to a longitude latitude. \| void \|		\| sentientFireWeapon \|\| sentient \|\| Order a sentient to fire their weapon in hand at nothing in particular. \|\| void
	\| sentientGoToLLExactly \| sentient,ll \| Order a sentient to go to a longitude latitude as precisely as possible. \| void \|		\|-
	\| sentientGoToRoom \| sentient,text \| Order a sentient to go to a room, by room name. The sentient needs to be aboard a spacecraft. \| void \|		\| sentientFollowAvatar \|\| sentient \|\| Order a sentient to follow the person. \|\| void
	\| sentientGoToUnit \| sentient,unit \| Order a sentient to go to a unit. \| void \|		\|-
	\| sentientHasItem \| sentient,commodity \| Test if the sentient possesses a specific commodity. \| bool \|		\| sentientFollowSentient \|\| sentient,sentient \|\| Order a sentient to follow another sentient. \|\| void
	\| sentientHasItemSpecific \| sentient,commodity,quality,empire,text \| Test if the sentient's gear contains a very specific commodity.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \| bool \|		\|-
			\| sentientGetIn \|\| sentient,atom \|\| Sentient moves close enough then rides the unit. e.g. boards a vehicle or spacecraft or rides a horse. \|\| void
			\|-
			\| sentientGetItem \|\| sentient,item \|\| Order a sentient to pick an item up off the ground. \|\| void
			\|-
			\| sentientGetOut \|\| sentient,atom \|\| Sentient gets out of an atom. Completed when atom is no longer their parent. If an active teleporter is present, they will get into it. \|\| void
			\|-
			\| sentientGoToAvatar \|\| sentient \|\| Order a sentient to go to the avatar. \|\| void
			\|-
			\| sentientGoToLL \|\| sentient,ll \|\| Order a sentient to go to a longitude latitude. \|\| void
			\|-
			\| sentientGoToLLExactly \|\| sentient,ll \|\| Order a sentient to go to a longitude latitude as precisely as possible. \|\| void
			\|-
			\| sentientGoToRoom \|\| sentient,text \|\| Order a sentient to go to a room, by room name. The sentient needs to be aboard a spacecraft. \|\| void
			\|-
			\| sentientGoToUnit \|\| sentient,unit \|\| Order a sentient to go to a unit. \|\| void
			\|-
			\| sentientHasItem \|\| sentient,commodity \|\| Test if the sentient possesses a specific commodity. \|\| bool
			\|-
			\| sentientHasItemSpecific \|\| sentient,commodity,quality,empire,text \|\| Test if the sentient's gear contains a very specific commodity.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \|\| bool
			\|-
	\| sentientHengeCeremony \| sentient,ll \| Order a sentient to perform the henge ceremony, if a henge is found near 'll'. \| void \|		\| sentientHengeCeremony \| sentient,ll \| Order a sentient to perform the henge ceremony, if a henge is found near 'll'. \| void \|
	\| sentientItemMakePermanent \| sentient,commodity,quality,empire,text \| Makes permanent a specific item in the sentient's gear. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \| void \|		\| sentientItemMakePermanent \| sentient,commodity,quality,empire,text \| Makes permanent a specific item in the sentient's gear. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \| void \|

Oggal: /* Npc Functions */

2026-06-27T02:29:19Z

Npc Functions

← Older revision		Revision as of 02:29, 27 June 2026
Line 349:		Line 349:
	Npc's are AI controlled citizens not including demiavatars who are AI controlled.		Npc's are AI controlled citizens not including demiavatars who are AI controlled.
	{\| class="wikitable"		{\| class="wikitable"
	\|+ ~~Caption text~~		\|+ NPC Functions
	\|-		\|-
	! Method Name !! Inputs !! Description !! Return Type		! Method Name !! Inputs !! Description !! Return Type

Oggal: /* Npc Functions */

2026-06-27T02:28:30Z

Npc Functions

← Older revision		Revision as of 02:28, 27 June 2026
Line 348:		Line 348:

	Npc's are AI controlled citizens not including demiavatars who are AI controlled.		Npc's are AI controlled citizens not including demiavatars who are AI controlled.
			{\| class="wikitable"
	\| Method Name \| Inputs \| Description \| Return Type \|		\|+ Caption text
	\|-~~--\|---\|---\|---\|~~		\|-
	\| npcCreditAccount \| npc,real \| Adds a number of cronodollars to the npc's account. \| void \|		! Method Name !! Inputs !! Description !! Return Type
	\| npcDebitAccount \| npc,real \| Subtracts a number of cronodollars from the npc's account. \| void \|		\|-
	\| npcDepart \| npc \| Causes an npc to depart the scene. The npc disappears instantly with no visual effect. \| void \|		\| npcCreditAccount \|\| npc,real \|\| Adds a number of cronodollars to the npc's account. \|\| void
	\| npcDie \| npc \| Kills an npc. They fall to the ground and die like other sentient creatures. Their body dies of massive internal injuries with no bleed out time. \| void \|		\|-
	\| npcEquipFromCity \| npc,gearslot,commodity,text \| Transfer an item to an npc's gear from the inventory of the current city.<br><br>Arguments:<br>'text' is an optional inscription to place on the item.<br><br>Quietly does nothing if the npc already has an item in that slot. \| void \|		\| npcDebitAccount \|\| npc,real \|\| Subtracts a number of cronodollars from the npc's account. \|\| void
	\| npcSetIndestructible \| npc,bool \| Sets indestructible state of an npc. \| void \|		\|-
	\| npcSetRole \| npc,npcrole \| Changes the role of an npc.<br><br>The role of an npc cannot be changed while they hold a berth. \| void \|		\| npcDepart \|\| npc \|\| Causes an npc to depart the scene. The npc disappears instantly with no visual effect. \|\| void
	\| npcSetVisible \| npc,bool \| Changes the visibility of an npc. \| void \|		\|-
	\| npcWantItem \| npc,commodity \| Causes the npc to want a specific commodity.<br><br>When an npc wants an item, they will make a bid if it is offered on the voice channel. \| void \|		\| npcDie \|\| npc \|\| Kills an npc. They fall to the ground and die like other sentient creatures. Their body dies of massive internal injuries with no bleed out time. \|\| void
	\| npcWantItemPrice \| npc,commodity,int,int \| Causes the npc to want a specific commodity at a specific price per unit.<br><br>When an npc wants an item, they will make a bid if it is offered on the voice channel.<br><br>Arguments:<br>First 'int' is the maximum number of the items wanted. 0 means no limit.<br>Second 'int' is price per unit. May be 0. \| void \|		\|-
	\| npcWantItemSpecific \| npc,commodity,quality,empire,text,int,int \| Causes the npc to want a very specific commodity.<br><br>When an npc wants an item, they will make a bid if it is offered on the voice channel.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank.<br>First 'int' is the maximum number of the items wanted. 0 means no limit.<br>Second 'int' is price per unit. May be 0. \| void \|		\| npcEquipFromCity \|\| npc,gearslot,commodity,text \|\| Transfer an item to an npc's gear from the inventory of the current city.<br><br>Arguments:<br>'text' is an optional inscription to place on the item.<br><br>Quietly does nothing if the npc already has an item in that slot. \|\| void
	\| npcWantOfferMade \| npc \| Test if the npc has made an offer to buy an item it wants that was offered for sale. \| bool \|		\|-
			\| npcSetIndestructible \|\| npc,bool \|\| Sets indestructible state of an npc. \|\| void
			\|-
			\| npcSetRole \|\| npc,npcrole \|\| Changes the role of an npc.<br><br>The role of an npc cannot be changed while they hold a berth. \|\| void
			\|-
			\| npcSetVisible \|\| npc,bool \|\| Changes the visibility of an npc. \|\| void
			\|-
			\| npcWantItem \|\| npc,commodity \|\| Causes the npc to want a specific commodity.<br><br>When an npc wants an item, they will make a bid if it is offered on the voice channel. \|\| void
			\|-
			\| npcWantItemPrice \|\| npc,commodity,int,int \|\| Causes the npc to want a specific commodity at a specific price per unit.<br><br>When an npc wants an item, they will make a bid if it is offered on the voice channel.<br><br>Arguments:<br>First 'int' is the maximum number of the items wanted. 0 means no limit.<br>Second 'int' is price per unit. May be 0. \|\| void
			\|-
			\| npcWantItemSpecific \|\| npc,commodity,quality,empire,text,int,int \|\| Causes the npc to want a very specific commodity.<br><br>When an npc wants an item, they will make a bid if it is offered on the voice channel.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank.<br>First 'int' is the maximum number of the items wanted. 0 means no limit.<br>Second 'int' is price per unit. May be 0. \|\| void
			\|-
			\| npcWantOfferMade \|\| npc \|\| Test if the npc has made an offer to buy an item it wants that was offered for sale.
			\| bool
			\|-
			\|}

	---		---

Oggal at 21:35, 26 June 2026

2026-06-26T21:35:22Z

← Older revision		Revision as of 21:35, 26 June 2026
Line 3:		Line 3:
	Custom stores can be created in any text editor. They require at minimum 2 story blocks, the catalyst and one other. They can contain any number of blocks.		Custom stores can be created in any text editor. They require at minimum 2 story blocks, the catalyst and one other. They can contain any number of blocks.

	== Functions ==		= Functions =
	=== Story Functions ===		== Story Functions ==

	Story functions configure the current story. Most story functions can only be used in the catalyst block. The only exception is the 'storyDroppable' function.		Story functions configure the current story. Most story functions can only be used in the catalyst block. The only exception is the 'storyDroppable' function.
Line 114:		Line 114:


	~~= Story Method Dump =~~

	~~# AuScript Scripting Reference~~		==Miscellaneous / Control Flow==

	## Miscellaneous / Control Flow
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Miscellaneous / Control Flow		\|+ Miscellaneous / Control Flow
Line 257:		Line 254:
	---		---

	## Creature Functions		== Creature Functions==

	Creature functions operate on a specific creature, which is the first argument of all creature functions.		Creature functions operate on a specific creature, which is the first argument of all creature functions.
Line 279:		Line 276:
	---		---

	## Find Functions		== Find Functions ==

	Find functions operate in the avatar's current environment. The environment is the solar system, design studio instance, or arena instance that contains the avatar.		Find functions operate in the avatar's current environment. The environment is the solar system, design studio instance, or arena instance that contains the avatar.
Line 298:		Line 295:
	---		---

	## Henge Functions		== Henge Functions ==

	Henge functions operate on the henges that interconnect ringworld arc sections with other worlds in the ringworld's sector.		Henge functions operate on the henges that interconnect ringworld arc sections with other worlds in the ringworld's sector.
Line 314:		Line 311:
	---		---

	## Item Functions		== Item Functions ==

	An item atom represents a commodity in the environment. Once it is picked up by anybody, the item atom ceases to exist and the item's data is added to their gear. A new atom is created when that item, or any item, is dropped in the environment.		An item atom represents a commodity in the environment. Once it is picked up by anybody, the item atom ceases to exist and the item's data is added to their gear. A new atom is created when that item, or any item, is dropped in the environment.
Line 332:		Line 329:
	---		---

	## Narrator Functions		== Narrator Functions ==

	Narrator communications are associated with the story itself and do not emanate from any in-game source.		Narrator communications are associated with the story itself and do not emanate from any in-game source.
Line 348:		Line 345:
	---		---

	## Npc Functions		== Npc Functions ==

	Npc's are AI controlled citizens not including demiavatars who are AI controlled.		Npc's are AI controlled citizens not including demiavatars who are AI controlled.
Line 369:		Line 366:
	---		---

	## Ringworld Functions		== Ringworld Functions ==

	Ringworld functions operate on a specific ringworld arc section.		Ringworld functions operate on a specific ringworld arc section.
Line 382:		Line 379:
	---		---

	## Sector Functions		== Sector Functions ==

	Sector functions operate on a specific sector, which is the first argument of all sector functions.		Sector functions operate on a specific sector, which is the first argument of all sector functions.
Line 393:		Line 390:
	---		---

	## Sentient Functions		== Sentient Functions ==

	Sentient functions operate on a specific sentient creature, which is the first argument of all sentient functions.		Sentient functions operate on a specific sentient creature, which is the first argument of all sentient functions.
Line 439:		Line 436:
	---		---

	## Ship Functions		== Ship Functions ==

	Ship functions operate on a specific spacecraft, which is the first argument of all ship functions.		Ship functions operate on a specific spacecraft, which is the first argument of all ship functions.
Line 466:		Line 463:
	---		---

	## Unit Functions		== Unit Functions ==

	A unit is any creature, vehicle, or spacecraft.		A unit is any creature, vehicle, or spacecraft.
Line 483:		Line 480:
	---		---

	## Vehicle Functions		== Vehicle Functions ==

	Vehicle functions operate on a specific vehicle, which is the first argument of all vehicle functions.		Vehicle functions operate on a specific vehicle, which is the first argument of all vehicle functions.
Line 497:		Line 494:
	---		---

	## World Functions		== World Functions ==

	World functions operate on a specific world, which is the first argument of all world functions.		World functions operate on a specific world, which is the first argument of all world functions.

Oggal: /* Custom Stories */

2026-06-26T20:46:35Z

Custom Stories

Show changes

Oggal: /* Avatar Functions */

2026-06-25T17:40:58Z

Avatar Functions

@@ Line 40: / Line 40: @@
 ! Method Name!! Arguments!! Description !! Return
 |-
+| avatar || || Returns the person executing the story.
 |}

Oggal at 17:01, 25 June 2026

2026-06-25T17:01:10Z

@@ Line 31: / Line 31: @@
 |-
 | storyResultText || int,text || Declares the text that explains a result code set by avatarStoryResult.
 |}

Oggal: Created page with "= Custom Stories = Custom stores can be created in any text editor. They require at minimum 2 story blocks, the catalyst and one other. They can contain any number of blocks. == Functions == === Story Functions === Story functions configure the current story. Most story functions can only be used in the catalyst block. The only exception is the 'storyDroppable' function. {| class="wikitable" |+ Story Functions |- ! Method Name!! Arguments!! Description !! Return |- |..."

2026-06-20T14:21:34Z

Created page with "= Custom Stories = Custom stores can be created in any text editor. They require at minimum 2 story blocks, the catalyst and one other. They can contain any number of blocks. == Functions == === Story Functions === Story functions configure the current story. Most story functions can only be used in the catalyst block. The only exception is the 'storyDroppable' function. {| class="wikitable" |+ Story Functions |- ! Method Name!! Arguments!! Description !! Return |- |..."

New page

= Custom Stories =

Custom stores can be created in any text editor. They require at minimum 2 story blocks, the catalyst and one other. They can contain any number of blocks.

== Functions ==
=== Story Functions ===

Story functions configure the current story. Most story functions can only be used in the catalyst block. The only exception is the 'storyDroppable' function.

{| class="wikitable"
|+ Story Functions
|-
! Method Name!! Arguments!! Description !! Return
|-
| storyTitle || text||
|-
| storyAuthor || text|| Identifies the author of the story. Required in catalyst block.

|-
| storyAutoRepeat|| || Enables the story to automatically start repeatedly, based on the catalyst. The story can restart within 10 seconds of being terminated if an interval is not specified. Only one auto started story can be active at a time.
|-
| storyAutoRepeatUntilComplete || int|| Enables the story to automatically start repeatedly, based on the catalyst. The story can restart within 10 seconds of being terminated if an interval is not specified.The story stops autostarting once it has been completed. A story that is dropped is not considered to be completed. Only one auto started story can be active at a time.
|-
| storyAutoStart || || Enables the story to automatically start once, based on the catalyst. Only one auto started story can be active at a time.
|-
| storyBrief|| text ||Gives a brief description of the story. Required in catalyst block.
|-
| storyDroppable || bool || Sets the current story's droppable state. The droppable state of a story can be changed at any time in the script. A story that is not droppable cannot be canceled by the avatar using the Jobs window. The avatar gets a thought message if they try dropping an undroppable story. Usually, avatars must be able to drop a story to enable it to restart. Disable drop only when dropping would break the story in some way.
|-
| storyInterval || int || Specifies the time interval in minutes before the story can start again. The time interval starts when the story terminates, whether by finishing or by dropping.
|-
| storyResultText || int,text || Declares the text that explains a result code set by avatarStoryResult.
|}

← Older revision		Revision as of 03:33, 27 June 2026
Line 450:		Line 450:
	\| sentientHasItemSpecific \|\| sentient,commodity,quality,empire,text \|\| Test if the sentient's gear contains a very specific commodity.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \|\| bool		\| sentientHasItemSpecific \|\| sentient,commodity,quality,empire,text \|\| Test if the sentient's gear contains a very specific commodity.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \|\| bool
	\|-		\|-
	\| sentientHengeCeremony \| sentient,ll \| Order a sentient to perform the henge ceremony, if a henge is found near 'll'. \| void \|		\| sentientHengeCeremony \|\| sentient,ll \|\| Order a sentient to perform the henge ceremony, if a henge is found near 'll'. \|\| void
	\| sentientItemMakePermanent \| sentient,commodity,quality,empire,text \| Makes permanent a specific item in the sentient's gear. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \| void \|		\|-
	\| sentientItemSetDropOnDeath \| sentient,int,commodity,quality,empire,text \| Sets the drop behavior of an item in a sentient's gear: 0=default random drop on death, 1=no drop, 2=always drop.<br><br>Arguments:<br>'int' is the new state. \| void \|		\| sentientItemMakePermanent \|\| sentient,commodity,quality,empire,text \|\| Makes permanent a specific item in the sentient's gear. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \|\| void
	\| sentientItemSetState \| sentient,int,commodity,quality,empire,text \| Sets the state of an item in a sentient's gear, such as the on/off state of a light or musical instrument. Nothing happens if the item does not support different states.<br><br>Arguments:<br>'int' is the new state. Valid values are in the range of 0 to 255. \| void \|		\|-
	\| sentientMoveAway \| sentient,atom,real,real \| Order a sentient to move away from 'atom'.<br><br>Arguments:<br>First 'real' is the distance to move in meters.<br>Second 'real' is the angle left or right from directly away in degrees. \| void \|		\| sentientItemSetDropOnDeath \|\| sentient,int,commodity,quality,empire,text \|\| Sets the drop behavior of an item in a sentient's gear: 0=default random drop on death, 1=no drop, 2=always drop.<br><br>Arguments:<br>'int' is the new state. \|\| void
	\| sentientMoveBack \| sentient,real \| Order a sentient to move backward a distance specified in meters. \| void \|		\|-
	\| sentientMoveClose \| sentient,atom,real \| Order a sentient to move close to atom, within a distance specified in meters. \| void \|		\| sentientItemSetState \|\| sentient,int,commodity,quality,empire,text \|\| Sets the state of an item in a sentient's gear, such as the on/off state of a light or musical instrument. Nothing happens if the item does not support different states.<br><br>Arguments:<br>'int' is the new state. Valid values are in the range of 0 to 255. \|\| void
	\| sentientMoveForward \| sentient,real \| Order a sentient to move forward a distance specified in meters. \| void \|		\|-
	\| sentientMoveToward \| sentient,atom,real \| Order a sentient to move toward 'atom'.<br><br>Arguments:<br>First 'real' is the distance to move in meters. Distance is truncated to the current distance to the atom.<br>Second 'real' is the angle left or right from directly toward in degrees. \| void \|		\| sentientMoveAway \|\| sentient,atom,real,real \|\| Order a sentient to move away from 'atom'.<br><br>Arguments:<br>First 'real' is the distance to move in meters.<br>Second 'real' is the angle left or right from directly away in degrees. \|\| void
	\| sentientOkToRun \| sentient,bool \| Sets whether a sentient is permitted to run to their destination. Default is yes. \| void \|		\|-
	\| sentientReload \| sentient,itemsub,commodity,quality,empire,text \| Order a sentient to reload their weapon. \| void \|		\| sentientMoveBack \|\| sentient,real \|\| Order a sentient to move backward a distance specified in meters. \|\| void
			\|-
			\| sentientMoveClose \|\| sentient,atom,real \|\| Order a sentient to move close to atom, within a distance specified in meters. \|\| void
			\|-
			\| sentientMoveForward \|\| sentient,real \|\| Order a sentient to move forward a distance specified in meters. \|\| void
			\|-
			\| sentientMoveToward \|\| sentient,atom,real \|\| Order a sentient to move toward 'atom'.<br><br>Arguments:<br>First 'real' is the distance to move in meters. Distance is truncated to the current distance to the atom.<br>Second 'real' is the angle left or right from directly toward in degrees. \|\| void
			\|-
			\| sentientOkToRun \|\| sentient,bool \|\| Sets whether a sentient is permitted to run to their destination. Default is yes. \|\| void
			\|-
			\| sentientReload \|\| sentient,itemsub,commodity,quality,empire,text \|\| Order a sentient to reload their weapon. \|\| void
			\|-
	\| sentientSay \|\| sentient,text,visage \|\| Order a sentient being to say a message on the Voice channel.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void		\| sentientSay \|\| sentient,text,visage \|\| Order a sentient being to say a message on the Voice channel.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\|-		\|-

← Older revision		Revision as of 03:30, 27 June 2026
Line 461:		Line 461:
	\| sentientOkToRun \| sentient,bool \| Sets whether a sentient is permitted to run to their destination. Default is yes. \| void \|		\| sentientOkToRun \| sentient,bool \| Sets whether a sentient is permitted to run to their destination. Default is yes. \| void \|
	\| sentientReload \| sentient,itemsub,commodity,quality,empire,text \| Order a sentient to reload their weapon. \| void \|		\| sentientReload \| sentient,itemsub,commodity,quality,empire,text \| Order a sentient to reload their weapon. \| void \|
	\| sentientSay \| sentient,text,visage \| Order a sentient being to say a message on the Voice channel.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\| sentientSay \|\| sentient,text,visage \|\| Order a sentient being to say a message on the Voice channel.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\| sentientSayAudio \| sentient,file,text,visage \| Order a sentient to say a message on the Voice channel. The audio emits from the sentient.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\|-
	\| sentientSayChoice \| sentient,choiceValue,text,visage \| Order a sentient being to say a choice on the Voice channel. A choice message appears with a bright green asterisk.<br><br>Several choices may be stated if each is given a different choiceValue.<br><br>Result of player's choice is tested using the choiceMade function.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\| sentientSayAudio \|\| sentient,file,text,visage \|\| Order a sentient to say a message on the Voice channel. The audio emits from the sentient.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\| sentientSayImage \| sentient,file,text,text,visage \| Order a sentient to say a message on the Voice channel. The image appears automatically.<br><br>Arguments:<br>'text' args are image title and text to say.<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\|-
	\| sentientSayTo \| sentient,atom,text,visage \| Order a sentient being to say a message on the Voice channel to someone. They will turn to face them.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \| void \|		\| sentientSayChoice \|\| sentient,choiceValue,text,visage \|\| Order a sentient being to say a choice on the Voice channel. A choice message appears with a bright green asterisk.<br><br>Several choices may be stated if each is given a different choiceValue.<br><br>Result of player's choice is tested using the choiceMade function.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\| sentientSellGearItem \| sentient,atom,commodity,int \| Offers an item from a sentient's gear on the Voice channel.<br><br>Arguments:<br>'atom' is the target of the sale, causing sentient to turn to face them; it can be null.<br>The best Q 'commodity' possessed by 'sentient' is offered for sale.<br>'int' is the price, which can be 0 to offer it for free. \| void \|		\|-
	\| sentientSetPosture \| sentient,posture \| Order a sentient to assume a posture. \| void \|		\| sentientSayImage \|\| sentient,file,text,text,visage \|\| Order a sentient to say a message on the Voice channel. The image appears automatically.<br><br>Arguments:<br>'text' args are image title and text to say.<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
	\| sentientStay \| sentient \| Order a sentient to stay at their current location. \| void \|		\|-
			\| sentientSayTo \|\| sentient,atom,text,visage \|\| Order a sentient being to say a message on the Voice channel to someone. They will turn to face them.<br><br>Arguments:<br>'visage' is the mouth pose after speaking, may be None to leave it as is. \|\| void
			\|-
			\| sentientSellGearItem \|\| sentient,atom,commodity,int \|\| Offers an item from a sentient's gear on the Voice channel.<br><br>Arguments:<br>'atom' is the target of the sale, causing sentient to turn to face them; it can be null.<br>The best Q 'commodity' possessed by 'sentient' is offered for sale.<br>'int' is the price, which can be 0 to offer it for free. \|\| void
			\|-
			\| sentientSetPosture \|\| sentient,posture \|\| Order a sentient to assume a posture. \|\| void
			\|-
			\| sentientStay \|\| sentient \|\| Order a sentient to stay at their current location. \|\| void
			\|-
			\|}
	---		---

← Older revision		Revision as of 03:27, 27 June 2026
Line 409:		Line 409:

	Sentient functions operate on a specific sentient creature, which is the first argument of all sentient functions.		Sentient functions operate on a specific sentient creature, which is the first argument of all sentient functions.
			{\| class="wikitable"
	\| Method Name \| Inputs \| Description \| Return Type \|		\|+ Sentient Functions
	\|-~~--\|---\|---\|---\|~~		\|-
	\| sentientAttackUnit \| sentient,unit \| Order a sentient to attack a unit. \| void \|		! Method Name !! Inputs !! Description !! Return Type
	\| sentientClearGear \| sentient \| Removes all items of gear. \| void \|		\|-
	\| sentientCreateGear \| sentient,gearslot,bool,commodity,quality,empire,text \| Create an item in a sentient's gear.<br><br>Arguments:<br>'bool' is true to make the item permanent. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br>'empire' is the empire of origin of the item.<br>'text' is inscribed on the item if not blank. If the item is a blueprint disk or drawing, the inscription can be used to pass the blueprint id. \| void \|		\| sentientAttackUnit \|\| sentient,unit \|\| Order a sentient to attack a unit. \|\| void
	\| sentientDropGear \| sentient,gearslot \| Drops the item at a sentient's gear slot. \| item \|		\|-
	\| sentientDropGearItem \| sentient,commodity \| Drops an item from a sentient's gear. \| item \|		\| sentientClearGear \|\| sentient \|\| Removes all items of gear. \|\| void
	\| sentientFireWeapon \| sentient \| Order a sentient to fire their weapon in hand at nothing in particular. \| void \|		\|-
	\| sentientFollowAvatar \| sentient \| Order a sentient to follow the person. \| void \|		\| sentientCreateGear \|\| sentient,gearslot,bool,commodity,quality,empire,text \|\| Create an item in a sentient's gear.<br><br>Arguments:<br>'bool' is true to make the item permanent. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br>'empire' is the empire of origin of the item.<br>'text' is inscribed on the item if not blank. If the item is a blueprint disk or drawing, the inscription can be used to pass the blueprint id. \|\| void
	\| sentientFollowSentient \| sentient,sentient \| Order a sentient to follow another sentient. \| void \|		\|-
	\| sentientGetIn \| sentient,atom \| Sentient moves close enough then rides the unit. e.g. boards a vehicle or spacecraft or rides a horse. \| void \|		\| sentientDropGear \|\| sentient,gearslot \|\| Drops the item at a sentient's gear slot. \|\| item
	\| sentientGetItem \| sentient,item \| Order a sentient to pick an item up off the ground. \| void \|		\|-
	\| sentientGetOut \| sentient,atom \| Sentient gets out of an atom. Completed when atom is no longer their parent. If an active teleporter is present, they will get into it. \| void \|		\| sentientDropGearItem \|\| sentient,commodity \|\| Drops an item from a sentient's gear. \|\| item
	\| sentientGoToAvatar \| sentient \| Order a sentient to go to the avatar. \| void \|		\|-
	\| sentientGoToLL \| sentient,ll \| Order a sentient to go to a longitude latitude. \| void \|		\| sentientFireWeapon \|\| sentient \|\| Order a sentient to fire their weapon in hand at nothing in particular. \|\| void
	\| sentientGoToLLExactly \| sentient,ll \| Order a sentient to go to a longitude latitude as precisely as possible. \| void \|		\|-
	\| sentientGoToRoom \| sentient,text \| Order a sentient to go to a room, by room name. The sentient needs to be aboard a spacecraft. \| void \|		\| sentientFollowAvatar \|\| sentient \|\| Order a sentient to follow the person. \|\| void
	\| sentientGoToUnit \| sentient,unit \| Order a sentient to go to a unit. \| void \|		\|-
	\| sentientHasItem \| sentient,commodity \| Test if the sentient possesses a specific commodity. \| bool \|		\| sentientFollowSentient \|\| sentient,sentient \|\| Order a sentient to follow another sentient. \|\| void
	\| sentientHasItemSpecific \| sentient,commodity,quality,empire,text \| Test if the sentient's gear contains a very specific commodity.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \| bool \|		\|-
			\| sentientGetIn \|\| sentient,atom \|\| Sentient moves close enough then rides the unit. e.g. boards a vehicle or spacecraft or rides a horse. \|\| void
			\|-
			\| sentientGetItem \|\| sentient,item \|\| Order a sentient to pick an item up off the ground. \|\| void
			\|-
			\| sentientGetOut \|\| sentient,atom \|\| Sentient gets out of an atom. Completed when atom is no longer their parent. If an active teleporter is present, they will get into it. \|\| void
			\|-
			\| sentientGoToAvatar \|\| sentient \|\| Order a sentient to go to the avatar. \|\| void
			\|-
			\| sentientGoToLL \|\| sentient,ll \|\| Order a sentient to go to a longitude latitude. \|\| void
			\|-
			\| sentientGoToLLExactly \|\| sentient,ll \|\| Order a sentient to go to a longitude latitude as precisely as possible. \|\| void
			\|-
			\| sentientGoToRoom \|\| sentient,text \|\| Order a sentient to go to a room, by room name. The sentient needs to be aboard a spacecraft. \|\| void
			\|-
			\| sentientGoToUnit \|\| sentient,unit \|\| Order a sentient to go to a unit. \|\| void
			\|-
			\| sentientHasItem \|\| sentient,commodity \|\| Test if the sentient possesses a specific commodity. \|\| bool
			\|-
			\| sentientHasItemSpecific \|\| sentient,commodity,quality,empire,text \|\| Test if the sentient's gear contains a very specific commodity.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \|\| bool
			\|-
	\| sentientHengeCeremony \| sentient,ll \| Order a sentient to perform the henge ceremony, if a henge is found near 'll'. \| void \|		\| sentientHengeCeremony \| sentient,ll \| Order a sentient to perform the henge ceremony, if a henge is found near 'll'. \| void \|
	\| sentientItemMakePermanent \| sentient,commodity,quality,empire,text \| Makes permanent a specific item in the sentient's gear. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \| void \|		\| sentientItemMakePermanent \| sentient,commodity,quality,empire,text \| Makes permanent a specific item in the sentient's gear. Permanent story items persist in the game after the story ends. Nonpermanent story items are removed when the story ends.<br><br>Arguments:<br>'text' is compared against the inscription only if 'text' is not blank. \| void \|