GetDescription

From NWN Lexicon
Jump to: navigation, search


GetDescription(object, int, int)

Gets the description of an object.

string GetDescription(
    object oObject,
    int bOriginalDescription = FALSE,
    int bIdentifiedDescription = TRUE
);

Parameters

oObject

The object from which you are obtaining the description.

bOriginalDescription

Retrieve the original description or the current description. (Default: FALSE)

bIdentified

Retrieve the identified description or the unidentified description (items only). (Default: TRUE)


Description

Gets the description of an object.



Remarks

oObject can be a creature, item, placeable, door, trigger, module object, or player character.

Note a trigger cannot have a description added in the normal toolset, but can be with SetDescription. In game you can't really examine descriptions usually.


If bOriginalDescription is set to TRUE, then any new description specified via a SetDescription scripting command is ignored and the original object's description is returned instead.


If oObject is an item, setting bIdentified to TRUE will return the identified description. Setting bIdentified to FALSE will return the item's unidentified description. This flag has no effect on objects other than items.


Version

1.69

Example

See SetDescription

See Also

functions: 

SetDescription



author: Mistress, contributor: Cereborn