Xordac: 1 revision imported

2017-10-23T23:23:20Z

1 revision imported

New page

=Get Data from Object Function Category=

A function that returns data from an object.

<br /><br />

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[CreatePersonalItemOn | CreatePersonalItemOn ]]
| Creates an personal item on the provided NPC.
|-
|
[[EndModule | EndModule ]]
| Used for determining if the current module is an end module.
|-
|
[[GetAreaOfEffectCreator | GetAreaOfEffectCreator ]]
| Gets the creator of an Area of Effect object.
|-
|
[[GetBaseItemType | GetBaseItemType ]]
| Determines the basic template for the item specified.
|-
|
[[GetColor | GetColor ]]
| Gets the color assigned to the specified color channel.
|-
|
[[GetCurrentHitPoints | GetCurrentHitPoints ]]
| Determines the number of hit points someone currently has.
|-
|
[[GetDescription | GetDescription ]]
| Gets the description of an object.
|-
|
[[GetFacingFromLocation | GetFacingFromLocation ]]
| Get the facing value from a location variable.
|-
|
[[GetFirstItemProperty | GetFirstItemProperty ]]
| Determines the first itemproperty on an item
|-
|
[[GetHardness | GetHardness ]]
| Determines the hardness of a door or placeable object.
|-
|
[[GetIsAreaAboveGround | GetIsAreaAboveGround ]]
| Determines whether an area is above ground or not.
|-
|
[[GetIsAreaNatural | GetIsAreaNatural ]]
| Returns whether an area is natural or not
|-
|
[[GetIsInSubArea | GetIsInSubArea ]]
| Checks if a creature has triggered an OnEnter event
|-
|
[[GetIsMagicalItem | GetIsMagicalItem ]]
| Returns TRUE if oItem has any item property that classifies it as magical item.
|-
|
[[GetIsObjectValid | GetIsObjectValid ]]
| Determines whether an object is valid.
|-
|
[[GetIsOpen | GetIsOpen ]]
| Check whether a placeable or door is currently open.
|-
|
[[GetIsTrapped | GetIsTrapped ]]
| Check whether an object is trapped.
|-
|
[[GetIsWeaponEffective | GetIsWeaponEffective ]]
| Check whether script owner's equipped weapon is able to damage a given object.
|-
|
[[GetItemACValue | GetItemACValue ]]
| Get the armor class (AC) of an item.
|-
|
[[GetItemAppearance | GetItemAppearance ]]
| Returns the appearance of an item
|-
|
[[GetItemCharges | GetItemCharges ]]
| Retrieves the number of charges remaining on a given item.
|-
|
[[GetItemCursedFlag | GetItemCursedFlag ]]
| Checks if an item is cursed
|-
|
[[GetItemHasItemProperty | GetItemHasItemProperty ]]
| Check whether an item has a given property.
|-
|
[[GetItemStackSize | GetItemStackSize ]]
| Retrieves the number of similar items in a stack.
|-
|
[[GetKeyRequiredFeedback | GetKeyRequiredFeedback ]]
| Get the feedback message that will be displayed when trying to unlock the object.
|-
|
[[GetLastAttacker | GetLastAttacker ]]
| Determine who last attacked a creature, door or placeable object.
|-
|
[[GetLastHostileActor | GetLastHostileActor ]]
| Gets the last living, non plot creature that performed a hostile act against the object.
|-
|
[[GetLastLocked | GetLastLocked ]]
| Get the last object that locked the caller.
|-
|
[[GetLastOpenedBy | GetLastOpenedBy ]]
| Get the last creature that opened the caller.
|-
|
[[GetLastSpellHarmful | GetLastSpellHarmful ]]
| Determines whether the last spell cast was harmful.
|-
|
[[GetLastUnlocked | GetLastUnlocked ]]
| Determines who unlocked the object or placeable.
|-
|
[[GetLastUsedBy | GetLastUsedBy ]]
| Get the last object that used the placeable object that is calling this function.
|-
|
[[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.
|-
|
[[GetLocked | GetLocked ]]
| Check whether a given object is locked.
|-
|
[[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.
|-
|
[[GetMeleeWeapon | GetMeleeWeapon ]]
| Returns TRUE if the item is a melee weapon.
|-
|
[[GetName | GetName ]]
| Retrieves the name of an object.
|-
|
[[GetNearestObject | GetNearestObject ]]
| Gets the nearest object, which matches given criteria, to the selected target.
|-
|
[[GetNearestObjectByTag | GetNearestObjectByTag ]]
| Returns the nearest object to a target by searching for the objectâs tag value.
|-
|
[[GetNearestObjectToLocation | GetNearestObjectToLocation ]]
| Returns the nearest object, which is of a specified type, to a given location.
|-
|
[[GetNextItemProperty | GetNextItemProperty ]]
| Determines the next itemproperty on an item
|-
|
[[GetObjectByTag | GetObjectByTag ]]
| Retrieves an object based on the tag given to it.
|-
|
[[GetObjectType | GetObjectType ]]
| Determines what type the object is.
|-
|
[[GetPercentageHPLoss | GetPercentageHPLoss ]]
| Determines how wounded a creature is as a percentage of their maximum HP.
|-
|
[[GetPlaceableLastClickedBy | GetPlaceableLastClickedBy ]]
| Determines the last object that default clicked (left clicked) on the placeable object.
|-
|
[[GetPlotFlag | GetPlotFlag ]]
| Determines whether an object is flagged as plot item.
|-
|
[[GetPortraitId | GetPortraitId ]]
| Determines the portraits.2da row number of the portrait.
|-
|
[[GetPortraitResRef | GetPortraitResRef ]]
| Determines the portrait resref of the object.
|-
|
[[GetPosition | GetPosition ]]
| Determines the position of a creature or object.
|-
|
[[GetRandomFriend | GetRandomFriend ]]
| Get a random nearby friend within the specified distance limit, that isn't busy doing something else.
|-
|
[[GetRandomObjectByTag | GetRandomObjectByTag ]]
| Get a random nearby object within the specified distance with the specified tag.
|-
|
[[GetRandomObjectByType | GetRandomObjectByType ]]
| Get a random nearby object within the specified distance with the specified type.
|-
|
[[GetRandomStop | GetRandomStop ]]
| Returns a randomly selected object with the tag "NW_STOP" that is within the area of the calling object.
|-
|
[[GetResRef | GetResRef ]]
| Returns the ResRef of an object.
|-
|
[[GetSittingCreature | GetSittingCreature ]]
| Determines which creature sitting on a particular object.
|-
|
[[GetSlashingWeapon | GetSlashingWeapon ]]
| Returns TRUE if the item is a slashing weapon.
|-
|
[[GetTag | GetTag ]]
| Determine the tag associated with an object.
|-
|
[[GetTileMainLight1Color | GetTileMainLight1Color ]]
| Determines the color of the first main light of a tile.
|-
|
[[GetTransitionTarget | GetTransitionTarget ]]
| Gets the associated transitional target.
|-
|
[[GetUseableFlag | GetUseableFlag ]]
| Determines if a placeable object is useable.
|-
|
[[GetWeaponRanged | GetWeaponRanged ]]
| Checks whether a given item is a ranged weapon.
|-
|
[[GetWeather | GetWeather ]]
| Gets the current weather conditions for a given area
|-
|
[[GetWeight | GetWeight ]]
| Retrieves the weight of an individual item, or the weight of all objects carried by a single creature.
|-
|
[[InvisibleTrue | InvisibleTrue ]]
| Returns TRUE if the object is hidden either magically or via stealth.
|-
|
[[IPGetHasItemPropertyByConst | IPGetHasItemPropertyByConst ]]
| Returns whether an item has an itemproperty.
|-
|
[[IPGetHasItemPropertyOnCharacter | IPGetHasItemPropertyOnCharacter ]]
| Returns whether a character has an item with a certain itemproperty type equipped.
|-
|
[[IPGetHasUseLimitation | IPGetHasUseLimitation ]]
| Returns whether an item has any usage limitations.
|-
|
[[IPGetIsBludgeoningWeapon | IPGetIsBludgeoningWeapon ]]
| Checks if an item is a bludgeoning weapon.
|-
|
[[IPGetIsIntelligentWeapon | IPGetIsIntelligentWeapon ]]
| Returns whether an item has the intelligent itemproperty.
|-
|
[[IPGetIsItemEquipable | IPGetIsItemEquipable ]]
| Checks if an item can be equipped.
|-
|
[[IPGetIsMeleeWeapon | IPGetIsMeleeWeapon ]]
| Checks if an item is a melee weapon.
|-
|
[[IPGetIsProjectile | IPGetIsProjectile ]]
| Checks if an item is a projectile.
|-
|
[[IPGetIsRangedWeapon | IPGetIsRangedWeapon ]]
| Checks if an item is a ranged weapon.
|-
|
[[IPGetItemHasItemOnHitPropertySubType | IPGetItemHasItemOnHitPropertySubType ]]
| Checks if an item has a specified onhit subtype itemproperty.
|-
|
[[IPGetItemHasProperty | IPGetItemHasProperty ]]
| Checks if an item has a matching itemproperty.
|-
|
[[IPGetNextArmorAppearanceType | IPGetNextArmorAppearanceType ]]
| Returns the next valid appearance type for an armor.
|-
|
[[IPGetNumberOfAppearances | IPGetNumberOfAppearances ]]
| Returns the number of armor part variations for the specified part.
|-
|
[[IPGetNumberOfItemProperties | IPGetNumberOfItemProperties ]]
| Returns the number of item properties present on an item.
|-
|
[[IPGetPrevArmorAppearanceType | IPGetPrevArmorAppearanceType ]]
| Returns the armor's previous valid appearance type for the specified part.
|-
|
[[IPGetWeaponEnhancementBonus | IPGetWeaponEnhancementBonus ]]
| Returns a weapon's enhancement bonus.
|-
|
[[IsMisc | IsMisc ]]
| Returns true if the basetype of the item is one of the misc. types of basetype.
|-
|
[[IsValidBaseItem | IsValidBaseItem ]]
| Checks to see if the baseitem type matches the one in the array AND if the item is "magical"
|-
|
[[PlayerWearsUniform | PlayerWearsUniform ]]
| Checks if a PC has a certain uniform equipped.
|-
|
[[SetIdentified | SetIdentified ]]
| Sets whether an object has been identified.
|-
|
[[SetLocked | SetLocked ]]
| Locks or unlocks a door or placeable.
|-
|
[[StringToRGBString | StringToRGBString ]]
| Given a string and an RGB color encoded string, this function returns an equivalent string that will display in the specified color.
|}

----
[[Category:Functions]]
[[Category:Function_Categories]]

Category:Get Data from Object Functions - Revision history

Xordac: 1 revision imported