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