Xordac: 1 revision imported

2017-10-23T23:23:19Z

1 revision imported

New page

=Get Data Function Category=

A function that returns a value.

 

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[CheckPartyForItem | CheckPartyForItem ]]
| Check party for possession of an item.
|-
|
[[Get2DAString | Get2DAString ]]
| Retrieves a string value from a *.2da file on a server.
|-
|
[[GetArea | GetArea ]]
| Returns the area oTarget is currently in.
|-
|
[[GetAreaFromLocation | GetAreaFromLocation ]]
| Returns the area that a particular location is in.
|-
|
[[GetCalendarDay | GetCalendarDay ]]
| Retrieves the current in-game calendar day.
|-
|
[[GetCalendarMonth | GetCalendarMonth ]]
| Determines the current in-game calendar month.
|-
|
[[GetCalendarYear | GetCalendarYear ]]
| Determine the current in-game calendar year.
|-
|
[[GetClickingObject | GetClickingObject ]]
| Used in the OnClick event to return the clicking object.
|-
|
[[GetCurrentAction | GetCurrentAction ]]
| Returns the currently executing Action.
|-
|
[[GetIsAreaAboveGround | GetIsAreaAboveGround ]]
| Determines whether an area is above ground or not.
|-
|
[[GetIsAreaNatural | GetIsAreaNatural ]]
| Returns whether an area is natural or not
|-
|
[[GetIsDMPossessed | GetIsDMPossessed ]]
| Returns whether the creature is possessed by a DM
|-
|
[[GetIsItemPropertyValid | GetIsItemPropertyValid ]]
| Checks if an itemproperty is valid.
|-
|
[[GetItemPropertyCostTable | GetItemPropertyCostTable ]]
| Returns the cost table number of the itemproperty.
|-
|
[[GetItemPropertyCostTableValue | GetItemPropertyCostTableValue ]]
| Returns the cost table value of an itemproperty.
|-
|
[[GetItemPropertyDurationType | GetItemPropertyDurationType ]]
| Gets the duration type of an itemproperty.
|-
|
[[GetItemPropertyParam1 | GetItemPropertyParam1 ]]
| Returns the Param1 number of the item property.
|-
|
[[GetItemPropertyParam1Value | GetItemPropertyParam1Value ]]
| Returns the Param1 value of the item property.
|-
|
[[GetItemPropertySubType | GetItemPropertySubType ]]
| Gets the subtype of an itemproperty.
|-
|
[[GetItemPropertyType | GetItemPropertyType ]]
| Returns the type of itemproperty a property is.
|-
|
[[GetLastRestEventType | GetLastRestEventType ]]
| Determines the status of the last PC rest.
|-
|
[[GetLastSpell | GetLastSpell ]]
| Determines the spell that was last cast.
|-
|
[[GetLastSpellCaster | GetLastSpellCaster ]]
| Determines who last cast a spell.
|-
|
[[GetLastTrapDetected | GetLastTrapDetected ]]
| Determines the trap last detected by the PC.
|-
|
[[GetLocalFloat | GetLocalFloat ]]
| Get the value of a decimal number stored on an object.
|-
|
[[GetLocalInt | GetLocalInt ]]
| Get the value of a whole number stored on an object.
|-
|
[[GetLocalLocation | GetLocalLocation ]]
| Get the data describing a location stored on an object.
|-
|
[[GetLocalObject | GetLocalObject ]]
| Get the data describing an object stored on an object.
|-
|
[[GetLocalString | GetLocalString ]]
| Get the value of a string of characters stored on an object.
|-
|
[[GetLocation | GetLocation ]]
| Gets the location of an object.
|-
|
[[GetLocked | GetLocked ]]
| Check whether a given object is locked.
|-
|
[[GetLockedObject | GetLockedObject ]]
| Finds the closest locked object up to a maximum of 10 objects away.
|-
|
[[GetLockKeyRequired | GetLockKeyRequired ]]
| Check whether an object requires a specific key to be unlocked.
|-
|
[[GetLockKeyTag | GetLockKeyTag ]]
| Gets the tag of the key that will open the lock on an object
|-
|
[[GetLockLockable | GetLockLockable ]]
| Check whether or not an object is lockable.
|-
|
[[GetLockLockDC | GetLockLockDC ]]
| Find a lock's lock DC.
|-
|
[[GetLockUnlockDC | GetLockUnlockDC ]]
| Find a lock's unlock DC.
|-
|
[[GetNearestCreatureToLocation | GetNearestCreatureToLocation ]]
| Gets the nearest creature, which matches supplied criteria, to a given location.
|-
|
[[GetNearestPC | GetNearestPC ]]
| Determines the nearest PC to a creature.
|-
|
[[GetNearestSeenOrHeardEnemy | GetNearestSeenOrHeardEnemy ]]
| Determines closest visual creature and determines the closest heard creature.
|-
|
[[GetNumberOfMeleeAttackers | GetNumberOfMeleeAttackers ]]
| Determines the number of enemies within a 5 meter radius of the target object.
|-
|
[[GetNumberOfRangedAttackers | GetNumberOfRangedAttackers ]]
| Determines the number of enemies outside a 5 meter radius of the target object.
|-
|
[[GetPhenoType | GetPhenoType ]]
| Returns the creature's currently set PhenoType (body type).
|-
|
[[GetSkinFloat | GetSkinFloat ]]
| Retrieves a persistent floating point variable from a creature's skin item.
|-
|
[[GetSkinInt | GetSkinInt ]]
| Retrieves a persistent integer variable from a creature's skin item.
|-
|
[[GetSkinString | GetSkinString ]]
| Retrieves a persistent string variable from a creature's skin item.
|-
|
[[GetWaypointByTag | GetWaypointByTag ]]
| Get the first waypoint with a specified tag.
|-
|
[[GetWeather | GetWeather ]]
| Gets the current weather conditions for a given area
|-
|
[[Global | Global ]]
| Returns an object stored locally on the calling object that holds quest related state information.
|-
|
[[IPGetIPWorkContainer | IPGetIPWorkContainer ]]
| Returns the container used for item property and appearance modifications in the module
|-
|
[[LineOfSightObject | LineOfSightObject ]]
| Is there a line of sight between two objects
|-
|
[[LineOfSightVector | LineOfSightVector ]]
| Returns whether there's a direct line between two positions
|}

----
author: NWN Lexicon Group, editor: Mistress, contributor: Axe Murderer 
[[Category:Functions]]
[[Category:Function_Categories]]

Category:Get Data Functions - Revision history

Xordac: 1 revision imported