Category:Get Data Functions

From NWN Lexicon
Jump to: navigation, search

Get Data Function Category

A function that returns a value.



Functions

Name Brief Description

CheckPartyForItem

Check party for possession of an item.

Get2DAString

Retrieves a string value from a *.2da file on a server.

GetArea

Returns the area oTarget is currently in.

GetAreaFromLocation

Returns the area that a particular location is in.

GetCalendarDay

Retrieves the current in-game calendar day.

GetCalendarMonth

Determines the current in-game calendar month.

GetCalendarYear

Determine the current in-game calendar year.

GetClickingObject

Used in the OnClick event to return the clicking object.

GetCurrentAction

Returns the currently executing Action.

GetIsAreaAboveGround

Determines whether an area is above ground or not.

GetIsAreaNatural

Returns whether an area is natural or not

GetIsDMPossessed

Returns whether the creature is possessed by a DM

GetIsItemPropertyValid

Checks if an itemproperty is valid.

GetItemPropertyCostTable

Returns the cost table number of the itemproperty.

GetItemPropertyCostTableValue

Returns the cost table value of an itemproperty.

GetItemPropertyDurationType

Gets the duration type of an itemproperty.

GetItemPropertyParam1

Returns the Param1 number of the item property.

GetItemPropertyParam1Value

Returns the Param1 value of the item property.

GetItemPropertySubType

Gets the subtype of an itemproperty.

GetItemPropertyType

Returns the type of itemproperty a property is.

GetLastRestEventType

Determines the status of the last PC rest.

GetLastSpell

Determines the spell that was last cast.

GetLastSpellCaster

Determines who last cast a spell.

GetLastTrapDetected

Determines the trap last detected by the PC.

GetLocalFloat

Get the value of a decimal number stored on an object.

GetLocalInt

Get the value of a whole number stored on an object.

GetLocalLocation

Get the data describing a location stored on an object.

GetLocalObject

Get the data describing an object stored on an object.

GetLocalString

Get the value of a string of characters stored on an object.

GetLocation

Gets the location of an object.

GetLocked

Check whether a given object is locked.

GetLockedObject

Finds the closest locked object up to a maximum of 10 objects away.

GetLockKeyRequired

Check whether an object requires a specific key to be unlocked.

GetLockKeyTag

Gets the tag of the key that will open the lock on an object

GetLockLockable

Check whether or not an object is lockable.

GetLockLockDC

Find a lock's lock DC.

GetLockUnlockDC

Find a lock's unlock DC.

GetNearestCreatureToLocation

Gets the nearest creature, which matches supplied criteria, to a given location.

GetNearestPC

Determines the nearest PC to a creature.

GetNearestSeenOrHeardEnemy

Determines closest visual creature and determines the closest heard creature.

GetNumberOfMeleeAttackers

Determines the number of enemies within a 5 meter radius of the target object.

GetNumberOfRangedAttackers

Determines the number of enemies outside a 5 meter radius of the target object.

GetPhenoType

Returns the creature's currently set PhenoType (body type).

GetSkinFloat

Retrieves a persistent floating point variable from a creature's skin item.

GetSkinInt

Retrieves a persistent integer variable from a creature's skin item.

GetSkinString

Retrieves a persistent string variable from a creature's skin item.

GetWaypointByTag

Get the first waypoint with a specified tag.

GetWeather

Gets the current weather conditions for a given area

Global

Returns an object stored locally on the calling object that holds quest related state information.

IPGetIPWorkContainer

Returns the container used for item property and appearance modifications in the module

LineOfSightObject

Is there a line of sight between two objects

LineOfSightVector

Returns whether there's a direct line between two positions

author: NWN Lexicon Group, editor: Mistress, contributor: Axe Murderer