Difference between revisions of "Object type"

From NWN Lexicon
Jump to: navigation, search
(Added info about other object types)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
=OBJECT_TYPE_* Constant Group=
 
 
 
Used to categorize types of objects.
 
Used to categorize types of objects.
 
<br /><br />
 
  
 
===Constants===
 
===Constants===
  
 
+
{| class="wikitable padding-5 sortable" border="1" style="min-width: 600px;"
 
+
|-
{| border="1" cellpadding="5"
+
! style="text-align: left;" | Constant
! width="25%" | Constant
+
! style="text-align: left; min-width: 60px;" | Value
! width="10%" | Value
+
! style="text-align: left;" class="unsortable" | Description
! Description
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_ALL
+
| OBJECT_TYPE_ALL
 
| 32767
 
| 32767
|
+
| Specifies all objects. Used for unrestricted searches. Strangely, OBJECT_TYPE_ALL and OBJECT_TYPE_INVALID equal the same value.
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies all objects. Used for unrestricted searches. Strangely, OBJECT_TYPE_ALL and OBJECT_TYPE_INVALID equal the same value.
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_AREA_OF_EFFECT
+
| OBJECT_TYPE_AREA_OF_EFFECT
 
| 16
 
| 16
|
+
| Specifies the object is an area of effect (AOE).
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies the object is an area of effect (AOE).
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_CREATURE
+
| OBJECT_TYPE_CREATURE
 
| 1
 
| 1
|
+
| Specifies the object is a creature (PC, animal, monster etc).
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies the object is a creature (PC, animal, monster etc).
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_DOOR
+
| OBJECT_TYPE_DOOR
 
| 8
 
| 8
|
+
| Specifies the object is a door.
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies the object is a door.
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_ENCOUNTER
+
| OBJECT_TYPE_ENCOUNTER
 
| 256
 
| 256
|
+
| Should specify an object which is an encounter, although no reference to this constant appears within NWScript other than its declaration.
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Should specify an object which is an encounter, although no reference to this constant appears within NWScript other than its declaration.
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_INVALID
+
| OBJECT_TYPE_INVALID
 
| 32767
 
| 32767
|
+
| Specifies the object is invalid. Strangely, OBJECT_TYPE_INVALID and OBJECT_TYPE_ALL equal the same value. OBJECT_TYPE_INVALID has an integer value of 32,767.
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies the object is invalid. Strangely, OBJECT_TYPE_INVALID and OBJECT_TYPE_ALL equal the same value. OBJECT_TYPE_INVALID has an integer value of 32,767.
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_ITEM
+
| OBJECT_TYPE_ITEM
 
| 2
 
| 2
|
 
{| style="border: 0" width="100%"
 
 
| style="border: 0" width="99%" valign="top" | Specifies the object is an item.
 
| style="border: 0" width="99%" valign="top" | Specifies the object is an item.
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_PLACEABLE
+
| OBJECT_TYPE_PLACEABLE
 
| 64
 
| 64
|
+
| Specifies the object is a placeable.
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies the object is a placeable.
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_STORE
+
| OBJECT_TYPE_STORE
 
| 128
 
| 128
|
+
| Specifies the object is a store.
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies the object is a store.
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_TRIGGER
+
| OBJECT_TYPE_TRIGGER
 
| 4
 
| 4
|
+
| Specifies the object is a trigger.
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies the object is a trigger.
 
|}
 
 
|-
 
|-
| valign="top" | OBJECT_TYPE_WAYPOINT
+
| OBJECT_TYPE_WAYPOINT
 
| 32
 
| 32
|
+
| Specifies the object is a waypoint.
{| style="border: 0" width="100%"
 
| style="border: 0" width="99%" valign="top" | Specifies the object is a waypoint.
 
|}
 
 
|}
 
|}
  
 +
===Remarks===
 +
Modules and Areas have an area type of 0. There is no constant for this value.
  
 
+
===See Also===
====See Also====
 
 
 
 
{| class="seealso"
 
{| class="seealso"
 
| width="1px" align="right" valign="top" | <font color="gray">functions: </font>
 
| width="1px" align="right" valign="top" | <font color="gray">functions: </font>
|
+
| [[GetObjectType]], [[CreateObject]]
[[SpeakOneLinerConversation | SpeakOneLinerConversation ]]
 
 
|}
 
|}
  
 
----
 
----
 
[[Category:Constants]]
 
[[Category:Constants]]
 +
{{DISPLAYTITLE:OBJECT_TYPE_* Constant Group}}

Latest revision as of 06:06, 8 September 2019

Used to categorize types of objects.

Constants

Constant Value Description
OBJECT_TYPE_ALL 32767 Specifies all objects. Used for unrestricted searches. Strangely, OBJECT_TYPE_ALL and OBJECT_TYPE_INVALID equal the same value.
OBJECT_TYPE_AREA_OF_EFFECT 16 Specifies the object is an area of effect (AOE).
OBJECT_TYPE_CREATURE 1 Specifies the object is a creature (PC, animal, monster etc).
OBJECT_TYPE_DOOR 8 Specifies the object is a door.
OBJECT_TYPE_ENCOUNTER 256 Should specify an object which is an encounter, although no reference to this constant appears within NWScript other than its declaration.
OBJECT_TYPE_INVALID 32767 Specifies the object is invalid. Strangely, OBJECT_TYPE_INVALID and OBJECT_TYPE_ALL equal the same value. OBJECT_TYPE_INVALID has an integer value of 32,767.
OBJECT_TYPE_ITEM 2 Specifies the object is an item.
OBJECT_TYPE_PLACEABLE 64 Specifies the object is a placeable.
OBJECT_TYPE_STORE 128 Specifies the object is a store.
OBJECT_TYPE_TRIGGER 4 Specifies the object is a trigger.
OBJECT_TYPE_WAYPOINT 32 Specifies the object is a waypoint.

Remarks

Modules and Areas have an area type of 0. There is no constant for this value.

See Also

functions:  GetObjectType, CreateObject