Tinkerer: blanked outdated page

2018-08-27T13:24:44Z

blanked outdated page

Larian octaaf at 10:11, 2 August 2017

2017-08-02T10:11:49Z

← Older revision		Revision as of 10:11, 2 August 2017
Line 1:		Line 1:
	~~<div>~~
	<h3>Queries</h3>		<h3>Queries</h3>
	<p>Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an <b><i>[out]</i></b> parameter and it does not match the value the query would returns. Below, this will be called the <b>Default Return Value</b>. If a query can also fail under other circumstances, this will be mentioned.<br>		<p>Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an <b><i>[out]</i></b> parameter and it does not match the value the query would returns. Below, this will be called the <b>Default Return Value</b>. If a query can also fail under other circumstances, this will be mentioned.<br>
Line 284:		Line 283:
	<div>		<div>
	<hr>		<hr>
			</div>
	</div>		</div>

Larian octaaf at 10:08, 2 August 2017

2017-08-02T10:08:31Z

Show changes

Larian octaaf: Blanked the page

2017-08-02T10:08:08Z

Blanked the page

Show changes

Larian octaaf at 10:04, 2 August 2017

2017-08-02T10:04:22Z

← Older revision		Revision as of 10:04, 2 August 2017
Line 1:		Line 1:
	<h2>Queries</h2>		<h3>Queries</h3>
	<p>Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an <b><i>[out]</i></b> parameter and it does not match the value the query would returns. Below, this will be called the <b>Default Return Value</b>. If a query can also fail under other circumstances, this will be mentioned.<br>		<p>Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an <b><i>[out]</i></b> parameter and it does not match the value the query would returns. Below, this will be called the <b>Default Return Value</b>. If a query can also fail under other circumstances, this will be mentioned.<br>
	</p>		</p>

Larian octaaf at 10:02, 2 August 2017

2017-08-02T10:02:34Z

← Older revision		Revision as of 10:02, 2 August 2017
Line 1:		Line 1:
	<h3>Queries</h3>		<h2>Queries</h2>
	<p>Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an <b><i>[out]</i></b> parameter and it does not match the value the query would returns. Below, this will be called the <b>Default Return Value</b>. If a query can also fail under other circumstances, this will be mentioned.<br>		<p>Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an <b><i>[out]</i></b> parameter and it does not match the value the query would returns. Below, this will be called the <b>Default Return Value</b>. If a query can also fail under other circumstances, this will be mentioned.<br>
	</p>		</p>

Larian octaaf: Created page with "

Queries

Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always..."

2017-08-02T10:02:15Z

Created page with "<h3>Queries</h3> Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always..."

New page

<h3>Queries</h3>
Queries request information about the state of the world from Osiris. They can be used in the part of a rule that checks conditions. Queries almost always succeed, except if you pass an initialised value as an [out] parameter and it does not match the value the query would returns. Below, this will be called the Default Return Value. If a query can also fail under other circumstances, this will be mentioned. 

 

<div>
<div>
<h4 style="font-size:1.1em;color:rgb(36,53,93)">CharacterGetEquippedItem</h4>
Full definitions
<ul><li>query CharacterGetEquippedItem([in](CHARACTERGUID)_Character, [in](STRING)_Slotname, [out](GUIDSTRING)_ItemGUID)</li></ul>
Description 
</div>
Returns in _ItemGUID the item equipped by _Character in slot _Slotname, if any. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist, or if no item is equipped in _Slotname. 
</li>
<li>_ItemGuid: The item equipped by _Character in _Slotname. 
</li></ul>
Notes
<ul><li>The valid values for _Slotname are: Helmet, Amulet, Breast, Belt, Gloves, Leggings, Boots, Weapon, Shield, Ring, Ring2. 
</li></ul>
See also
<ul><li>CharacterUnequipItem 
</li></ul>
<div>
<h4>CharacterGetHenchmanPresetPrice</h4>
<div style="font-size:13.3333px">
Full definitions
<ul style="font-size:13.3333px"><li>query CharacterGetHenchmanPresetPrice([in](STRING)_Preset, [in](CHARACTERGUID)_Character, [out](INTEGER)_Price)</li></ul>
Description 
Returns the price of the preset scaled to the level of _Character. 

Return values
<ul style="font-size:13.3333px"><li>_Price: The price of the preset scaled to the level of _Character. 
</li></ul>
Notes
<ul style="font-size:13.3333px"><li>Presets come from the folder ".../DOS2/Data/Mods/Shared/CharacterCreation/HenchmanPresets/"</li>
<li>Presets can be customized using the following documentation: link</li></ul>
<div>
See also
<ul style="font-size:13.3333px"><li>CharacterApplyHenchmanPreset 
</li></ul>
</div>
</div>
</div>
<div>
<div>
<h4>CharacterIsAlly</h4>
Full definitions
<ul><li>query CharacterIsAlly([in](CHARACTERGUID)_Character, [in](CHARACTERGUID)_OtherCharacter, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Character is an ally of _OtherCharacter. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Bool: 1 if _Character and _OtherCharacter are allies, 0 if not. 
</li></ul>
Notes
<ul><li>Also works outside combat.</li>
<li>If _Character or _OtherCharacter is dead or dying, the result solely depends on the characters' alignments (factions). If they are alive, it is also influenced by temporary hostile relations, e.g. induced by attacking a neutral character. 
</li></ul>
See also
<ul><li>CharacterIsNeutral</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsEnemy</h4>
Notes
<ul><li>See CharacterIsAlly for detailed information, except that this query returns whether the characters are enemies. 
</li></ul>
See also
<ul><li>CharacterIsAlly</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsNeutral</h4>
Notes
<ul><li>See CharacterIsAlly for detailed information, except that this query returns whether the characters are neutral. 
</li></ul>
See also
<ul><li>CharacterIsAlly</li>
<li>CharacterIsEnemy 
</li></ul>
<h4>CharacterIsPartyFollower</h4>
Full definitions
<ul><li>query CharacterIsPartyFollower([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Character is a character that follows a player character around. An NPC can be instructed to do so through CharacterFollowCharacter. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is a party follower, 0 if not. 
</li></ul>
Notes
<ul><li>CharacterIsPlayer will also return true for party followers. 
</li></ul>
See also
<ul><li>CharacterIsPlayer</li>
<li>CharacterFollowCharacter</li></ul>
<h4>CharacterIsPlayer</h4>
Full definitions
<ul><li>query CharacterIsPlayer([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Character is player-controlled. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is player-controlled, 0 if not. 
</li></ul>
Notes
<ul><li>Apart from avatars and recruited companions, player-controlled characters also include summons and followers.</li></ul>
See also
<ul><li>CharacterIsPartyFollower</li>
<li>CharacterIsSummon</li>
<li>CharacterFollowCharacter</li></ul>
<h4>CharacterIsSummon</h4>
Full definitions
<ul><li>query CharacterIsSummon([in](CHARACTERGUID)_Character, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Character is a summon. Summon can be player-controlled or not. 

Return values
<ul><li>Success/Failure: Fails if _Character does not exist. 
</li>
<li>_Bool: 1 if _Character is a summon, 0 if not. 
</li></ul>
Notes
<ul><li> 
</li>
<li>Summons can also be distinguished by the fact that hey have the SUMMON tag.</li>
<li>If you wish to know whether a summon is player-controlled, also check CharacterIsPlayer. 
</li></ul>
See also
<ul><li>CharacterIsPlayer</li></ul>
<h4>GetClosestAlivePlayer</h4>
Full definitions
<ul><li>query GetClosestAlivePlayer([in](GUIDSTRING)_Target, [out](CHARACTERGUID)_Player)</li></ul>
Description 
</div>
<div>
Gets the closest player to _Target that is alive and stores it in _Player.
Return values
<ul><li>Success/Failure: Fails if no living player is found. 
</li>
<li>_Player: The found player character. 
</li></ul>
Notes
<ul><li>Be careful if you check for extra conditions on the returned player: if any of those conditions fail, no other players will be considered.</li>
<li>If you want to start a dialog, use ProcGetClosestAvailableCharacterTo</li></ul>
See also
<ul><li>Helper ProcGetClosestAvailableCharacterTo</li></ul>
<div>
<div>
<h4>GetDistanceTo</h4>
Full definitions
<ul><li>query GetDistanceTo([in](GUIDSTRING)_Object1, [in](GUIDSTRING)_Object2, [out](REAL)_Dist)</li></ul>
Description 
</div>
Calculates the distance between _Object1 and _Object2.
Return values
<ul><li>Success/Failure: Fails if if either _Object1 or _Object2 is in a container or in an inventory. Use ItemIsInInventory to check for this.</li>
<li>_Dist: The distance in metres.</li></ul>
Notes
<ul><li>/ 
</li></ul>
See also 

<ul><li>ItemIsInInventory 
</li></ul>
<h4>GetInventoryOwner</h4>
Full definitions
<ul><li>query GetInventoryOwner([in](ITEMGUID)_Item, [out](GUIDSTRING)_Owner)</li></ul>
Description 
Returns the inventory/container that holds _Item in _Owner. 

Return values
<ul><li>Success/Failure: Fails if _Item is not in anyone's inventory nor in a container. 
</li>
<li>_Owner: The character or item in whose inventory the item currently resides. 
</li></ul>
Notes 

<ul><li>This call returns the outermost container. I.e., if a character has crate in their inventory, and the crate contains a pouch with the item, this call will return the character. 
</li></ul>
See also 

<ul><li>ItemIsInInventory 
</li></ul>
<h4>GetRandomPositionInTrigger</h4>
Full definitions
<ul><li>query GetRandomPositionInTrigger([in](TRIGGERGUID)_Trigger, [out](REAL)_X, [out](REAL)_Y, [out](REAL)_Z)</li></ul>
Description 
Returns a random position that is valid on the AI-grid inside _Trigger. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Trigger: A box trigger inside which the random position should be gotten. 
</li>
<li>_X, _Y, _Z: the coordinates of the random position 
</li></ul>
Notes 

<ul><li>This routine will first get a random position in the trigger, and if this random position is not valid on the AI-grid, the coordinates will be snapped to a nearby valid position on the AI-grid.</li>
<li>This call does not work for polytriggers</li></ul>
See also 

<ul><li>/ 
</li></ul>
<h4>HasActiveStatus</h4>
Full definitions
<ul><li>query HasActiveStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Target is currently under the influence of _Status. 

Return values
<ul><li>Success/Failure: Default return value. 
</li>
<li>_Bool: 0 if _Target is currently not under the influence of _Status, 1 if it is. 
</li></ul>
Notes 

<ul><li>/</li></ul>
See also 

<ul><li>HasAppliedStatus 
</li></ul>
<h4>HasAppliedStatus</h4>
Full definitions
<ul><li>query HasAppliedStatus([in](GUIDSTRING)_Target, [in](STRING)_Status, [out](INTEGER)_Bool)</li></ul>
Description 
Returns whether _Status has been applied to _Target. _Target may or may not yet actually be under its influence. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_Bool: 0 if _Status has not been applied to _Target, 1 if it has been. 
</li></ul>
Notes
<ul><li>In virtually all cases, use HasActiveStatus instead. The main purpose of this query is for crime reactions, and is only needed due to frame delays between code and Osiris. 
</li></ul>
See also 

<ul><li>HasActiveStatus 
</li></ul>
<h4>IsSpeakerReserved 
</h4>
Full definitions
<ul><li>query IsSpeakerReserved([in](GUIDSTRING)_Speaker, [out](INTEGER)_success)</li></ul>
Description 
Returns whether _Speaker is already in a dialog. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_success: 0 if _Speaker is currently not in a dialog, 1 otherwise. 
</li></ul>
Notes
<ul><li>/</li></ul>
See also 

<ul><li>DialogStartRequested</li>
<li>Proc_StartDialog 
</li></ul>
<h4>ItemIsInInventory</h4>
Full definitions
<ul><li>query ItemIsInInventory([in](ITEMGUID)_Item, [out](INTEGER)_Bool)</li></ul>
Description 
</div>
Returns whether _Item is in an inventory. This includes both character and container inventories. 

Return values
<ul><li>Success/Failure: Default return value.</li>
<li>_Bool: 0 if _Item is not in an inventory (as defined above), 1 if it is. 
</li></ul>
Notes
<ul><li>/</li></ul>
See also 

<ul><li>GetInventoryOwner</li></ul>
<div>
<hr>
</div>

Osiris API Tips Queries - Revision history