Dragon Age Toolset Wiki - User contributions [en]

CreateObject

2009-11-13T07:59:13Z

Shade Sharphook: /* Examples */

{{dafunction
|name=CreateObject
|brief=Create an object in the specified location. Will attempt to use a corresponding pool if one exists.
|param1type=int
|param1name=nObjectType
|param1desc=The object type (placeable, creature, etc)
|param1default=
|param2type=resource
|param2name=rTemplate
|param2desc=The template to use
|param2default=
|param3type=location
|param3name=lLoc
|param3desc=Location of the object
|param3default=
|param4type=string
|param4name=sOverrideScript
|param4desc=Script assigned to the object. If empty, the engine will use the template script
|param4default=""
|param5type=int
|param5name=bSpawnActive
|param5desc=Whether or not this object is enabled at spawn time
|param5default=TRUE
|param6type=int
|param6name=bNoPermDeath
|param6desc=Set to TRUE to avoid destroying the object permanently (only valid for pool creatures)
|param6default=FALSE
|returntype=object
|returndesc=The new object, OBJECT_INVALID on failure
|sourcefile=script.ldf
|sourcemodule=
}}




== Remarks ==


Note that dynamic creation of objects in the engine is subject to a host of limitations, reason being attempts to cut down 'unaccounted' memory usage.

Try avoiding CreateObject whenever possible.

These objects can be created with CreateObject: 
- Creature 
- Placeable 

These objects can not be created with CreateObject: 
- Merchant 

== Examples ==

To create a creature: 
CreateObject(OBJECT_TYPE_CREATURE, R"<name>.utc", <location>); 
<name> = Resource Name 
<location> = Location. See [[GetLocation]] for an example. 

== See also ==

[[CreatePool]], [[DestroyObject]], [[OBJECT_TYPE*]]
[[Category: Object functions]]

GetLocation

2009-11-13T07:55:55Z

Shade Sharphook:

{{dafunction
|name=GetLocation
|brief=Returns the location of the specified object.
|param1type=object
|param1name=oObject
|param1desc=the object to get the location of
|returntype=location
|returndesc=a valid location on success or invalid location on error
|sourcefile=script.ldf
|sourcemodule=
}}

== Description ==

This function returns the location of the specified object.
If an invalid object is specified, then an invalid location will be returned.




== Examples ==

To get the location of the current PC/Hero: 
location currentLocation = GetLocation(GetHero());

== See also ==

[[IsLocationValid]]
[[Category: Locations functions]]

CreateObject

2009-11-13T07:24:15Z

Shade Sharphook: /* Remarks */

{{dafunction
|name=CreateObject
|brief=Create an object in the specified location. Will attempt to use a corresponding pool if one exists.
|param1type=int
|param1name=nObjectType
|param1desc=The object type (placeable, creature, etc)
|param1default=
|param2type=resource
|param2name=rTemplate
|param2desc=The template to use
|param2default=
|param3type=location
|param3name=lLoc
|param3desc=Location of the object
|param3default=
|param4type=string
|param4name=sOverrideScript
|param4desc=Script assigned to the object. If empty, the engine will use the template script
|param4default=""
|param5type=int
|param5name=bSpawnActive
|param5desc=Whether or not this object is enabled at spawn time
|param5default=TRUE
|param6type=int
|param6name=bNoPermDeath
|param6desc=Set to TRUE to avoid destroying the object permanently (only valid for pool creatures)
|param6default=FALSE
|returntype=object
|returndesc=The new object, OBJECT_INVALID on failure
|sourcefile=script.ldf
|sourcemodule=
}}




== Remarks ==


Note that dynamic creation of objects in the engine is subject to a host of limitations, reason being attempts to cut down 'unaccounted' memory usage.

Try avoiding CreateObject whenever possible.

These objects can be created with CreateObject: 
- Creature 
- Placeable 

These objects can not be created with CreateObject: 
- Merchant 

== Examples ==

To Create a creature: 
CreateObject(OBJECT_TYPE_CREATURE, R"<name>.utc", <location>); 
<name> = Resource Name 
<location> = Location. See [[GetLocation]] for an example. 

== See also ==

[[CreatePool]], [[DestroyObject]], [[OBJECT_TYPE*]]
[[Category: Object functions]]

CreateObject

2009-11-13T07:06:28Z

Shade Sharphook:

{{dafunction
|name=CreateObject
|brief=Create an object in the specified location. Will attempt to use a corresponding pool if one exists.
|param1type=int
|param1name=nObjectType
|param1desc=The object type (placeable, creature, etc)
|param1default=
|param2type=resource
|param2name=rTemplate
|param2desc=The template to use
|param2default=
|param3type=location
|param3name=lLoc
|param3desc=Location of the object
|param3default=
|param4type=string
|param4name=sOverrideScript
|param4desc=Script assigned to the object. If empty, the engine will use the template script
|param4default=""
|param5type=int
|param5name=bSpawnActive
|param5desc=Whether or not this object is enabled at spawn time
|param5default=TRUE
|param6type=int
|param6name=bNoPermDeath
|param6desc=Set to TRUE to avoid destroying the object permanently (only valid for pool creatures)
|param6default=FALSE
|returntype=object
|returndesc=The new object, OBJECT_INVALID on failure
|sourcefile=script.ldf
|sourcemodule=
}}




== Remarks ==


Note that dynamic creation of objects in the engine is subject to a host of limitations, reason being attempts to cut down 'unaccounted' memory usage.

Try avoiding CreateObject whenever possible.

== Examples ==

To Create a creature: 
CreateObject(OBJECT_TYPE_CREATURE, R"<name>.utc", <location>); 
<name> = Resource Name 
<location> = Location. See [[GetLocation]] for an example. 

== See also ==

[[CreatePool]], [[DestroyObject]], [[OBJECT_TYPE*]]
[[Category: Object functions]]

GetLocation

2009-11-13T07:01:22Z

Shade Sharphook:

{{Generated}}
{{dafunction
|name=GetLocation
|brief=Returns the location of the specified object.
|param1type=object
|param1name=oObject
|param1desc=the object to get the location of
|returntype=location
|returndesc=a valid location on success or invalid location on error
|sourcefile=script.ldf
|sourcemodule=
}}

== Description ==

This function returns the location of the specified object.
If an invalid object is specified, then an invalid location will be returned.




== Examples ==

To get the location of the current PC/Hero: 
location currentLocation = GetLocation(GetHero());

== See also ==

[[IsLocationValid]]
[[Category: Locations functions]]

CreateObject

2009-11-13T06:54:49Z

Shade Sharphook: /* See also */

{{dafunction
|name=CreateObject
|brief=Create an object in the specified location. Will attempt to use a corresponding pool if one exists.
|param1type=int
|param1name=nObjectType
|param1desc=The object type (placeable, creature, etc)
|param1default=
|param2type=resource
|param2name=rTemplate
|param2desc=The template to use
|param2default=
|param3type=location
|param3name=lLoc
|param3desc=Location of the object
|param3default=
|param4type=string
|param4name=sOverrideScript
|param4desc=Script assigned to the object. If empty, the engine will use the template script
|param4default=""
|param5type=int
|param5name=bSpawnActive
|param5desc=Whether or not this object is enabled at spawn time
|param5default=TRUE
|param6type=int
|param6name=bNoPermDeath
|param6desc=Set to TRUE to avoid destroying the object permanently (only valid for pool creatures)
|param6default=FALSE
|returntype=object
|returndesc=The new object, OBJECT_INVALID on failure
|sourcefile=script.ldf
|sourcemodule=
}}




== Remarks ==


Note that dynamic creation of objects in the engine is subject to a host of limitations, reason being attempts to cut down 'unaccounted' memory usage.

Try avoiding CreateObject whenever possible.




== See also ==

[[CreatePool]], [[DestroyObject]], [[OBJECT_TYPE*]]
[[Category: Object functions]]