Dragon Age Toolset Wiki - User contributions [en]

Ability ApplyUpkeepEffects

2011-03-04T01:04:13Z

Yokmp: added some explains

{{dafunction
|name = Ability_ApplyUpkeepEffects
|brief = {{undocumented}}
|param1type = object
|param1name = oCaster
|param1desc = The Caster of the Ability on which the upkeep will be applied.
|param1default =
|param2type = int
|param2name = nAbility
|param2desc = The Ability itself.
|param2default =
|param3type = effect
|param3arra=true
|param3name = eEffects
|param3desc = The Effects on which the upkeep come from.
|param3default =
|param4type = object
|param4name = oTarget
|param4desc = The Target is the Caster. It is not needed to change the default value.
|param4default =OBJECT_INVALID
|param5type = int
|param5name = bPartywide
|param5desc = Is the Effect Partywide or not.
|param5default =FALSE
|returntype = void
|returndesc =
|sourcefile = ability_h
|sourcemodule = Core Resources
}}



Upkeep effects are permanent until the effect is removed. They also set the UI-icon toggle inside the effect based on the ability ID.



Ability_ApplyUpkeepEffects is more a Wrapper for _ApplyUpkeepEffect than a Function.
See [[_ApplyUpkeepEffect]] for more Informations.



Here is some code from the function itself:

// as explained above, the Target becomes the Caster.
if (!IsObjectValid(oTarget))
{
oTarget = oCaster;
}

// now loop through the Effects[i]
for (i = 0; i < nCount; i++)
{
_ApplyUpkeepEffect( oCaster, eEffects[i], nAbility, oTarget, bPartywide);
}

// define the spells mana cost and talents stamina cost
effect eUpkeep = EffectUpkeep(UPKEEP_TYPE_MANASTAMINA , fCost, nAbility, oTarget, bPartywide);

// the last step is to apply the effect on the target(caster)
ApplyEffectOnObject(EFFECT_DURATION_TYPE_PERMANENT, eUpkeep, oCaster, 0.0f, oCaster, nAbility);

== See also ==

[[Ability_ApplyUpkeepEffect]]

Ability ApplyUpkeepEffects

2011-03-04T00:42:57Z

Yokmp: added description

{{dafunction
|name = Ability_ApplyUpkeepEffects
|brief = {{undocumented}}
|param1type = object
|param1name = oCaster
|param1desc = {{undocumented}}
|param1default =
|param2type = int
|param2name = nAbility
|param2desc = {{undocumented}}
|param2default =
|param3type = effect
|param3arra=true
|param3name = eEffects
|param3desc = {{undocumented}}
|param3default =
|param4type = object
|param4name = oTarget
|param4desc = {{undocumented}}
|param4default =OBJECT_INVALID
|param5type = int
|param5name = bPartywide
|param5desc = {{undocumented}}
|param5default =FALSE
|returntype = void
|returndesc =
|sourcefile = ability_h
|sourcemodule = Core Resources
}}



Upkeep effects are permanent until the effect is removed. They also set the UI-icon toggle inside the effect based on the ability ID.







== See also ==

[[Ability_ApplyUpkeepEffect]]

EquipDefaultItem

2011-03-02T02:51:26Z

Yokmp: created

{{dafunction
|name=EquipDefaultItem
|brief=Equip default creature item based on appearance (only if none equipped).
|param1type = int
|param1name = nAppType
|param1desc = The Appearance Type, see [[GetAppearanceType]].
|param1default =
|param2type = int
|param2name = nTargetSlot
|param2desc = see [[INVENTORY_SLOT*]]
|param2default =
|param3type = string
|param3name = s2daColumnName
|param3desc = It determines which equipment is to be equipped with the creature (e.g. "DefaultWeapon").
|param3default =

|returntype = void
|returndesc =
|sourcefile = creature_core
|sourcemodule = Core Resources
}}













[[Category:Undocumented]]

Chargen ModifyCreaturePropertyBase

2011-03-01T01:49:03Z

Yokmp: created

{{dafunction
|name=Chargen_ModifyCreaturePropertyBase
|brief=Modifiers a creature property base value by a given number
|param1type = object
|param1name = oChar
|param1desc = Affected charakter.
|param1default =
|param2type = int
|param2name = nProperty
|param2desc = The property to modifiy (see [[PROPERTY*]]).
|param2default =
|param3type = float
|param3name = fModifyBy
|param3desc = The value by which the property is modified.
|param3default =

|returntype = void

|returndesc = returns the lesser value of both
|sourcefile = sys_chargen_h
|sourcemodule = Core Resources
}}



Function to modify the baseproperty of a creature.










[[Category:Undocumented]]

MinF

2011-03-01T01:36:41Z

Yokmp:

{{dafunction
|name=MinF
|brief=Returns the lesser value of f1 and f2
|param1type = float
|param1name = f1
|param1desc = Float 1
|param1default =
|param2type = float
|param2name = f2
|param2desc = Float 2
|param2default =

|returntype = float
|returndesc = returns the lesser value of both
|sourcefile = core_h
|sourcemodule = Core Resources
}}













[[Category:Undocumented]]

GetParty

2011-02-28T17:12:23Z

Yokmp: added param1 and return description

{{Generated with errors}}
{{dafunction
|name=GetParty
|brief=Returns the object for the party
|param1type=object
|param1name=oCreature
|param1desc=The creature of which we want to know the party.
|returntype=object
|returndesc=Returns the object for the party.
|sourcefile=script.ldf
|sourcemodule=
}}













[[Category: Players functions]]

GetPartyList

2011-02-28T17:08:00Z

Yokmp: corrected the object[] to object[]

Returns the party list for the creature
<dascript>
object[] GetPartyList(

object oCreature = -1

);
</dascript>
'''Parameters:'''

''oCreature''

'''Returns:'''

An array containing the objects of all the party members.

'''Source:'''

[[script.ldf]]
== Description ==

Returns the whole current Party of oCreature (Default is the Hero-Party)

== Remarks ==

The Hero is included in the Array

== Examples ==


/********************************************/
/*
* Description:
* Checks the whole party for a specified
* item to have in inventory (conversation
* condition script)
*
* Created By: GameScripting
* Created On: 12.01.2011
*/
/********************************************/

int StartingConditional()
{
// Gets the Partylist of the Hero
object[] oPartyList = GetPartyList();

// Gets the size of the Party
int nPartySize = GetArraySize(oPartyList);

// A simple Counter Variable
int i = 0;
object oItem;

// We'll loop though the whole party to check for one of the followers
// to have the specified item
for(i; i < nPartySize; i++)
{
// Get the Item-Object
oItem = GetItemPossessedBy(oPartyList[i], "MyItemTag");

// If the object is valid return true ...
if(IsObjectValid(oItem))
{
return TRUE;
}
}

// ... otherwise return false
return FALSE;
}

== See also ==

[[GetParty]]()

[[Category: Party and group control]]

Chargen ApplyClassAbilities

2011-02-28T09:55:16Z

Yokmp: created

{{dafunction
|name=Chargen_ApplyClassAbilities
|brief=Applies the abilities granted to a character because of picking a class.
|param1type=object
|param1name=oChar
|param1desc=The character.
|param1default=
|param2type=int
|param2name=nClass
|param2desc=Represents the Row of the M2DA_base.
|param2default=
|param3type=int
|param3name=bUnApply
|param3desc=Whether to apply (default) or unapply the modifier.
|param3default=FALSE
|returntype=void
|returndesc=
|sourcefile=sys_chargen_h
|sourcemodule=core
}}



Reads the class from cla_base.xls and applies it.

== Remarks ==





== See also ==

Chargen SelectCoreClass

2011-02-28T09:45:49Z

Yokmp:

{{dafunction
|name=Chargen_SelectCoreClass
|brief=Sets the character's core class.
|param1type=object
|param1name=oChar
|param1desc=The character.
|param1default=
|param2type=int
|param2name=nClass
|param2desc=The ID of the core class (CLASS_*)
|param2default=
|param3type=int
|param3name=bUnApply
|param3desc=TRUE resets the character.
|param3default=FALSE
|returntype=void
|returndesc=
|sourcefile=sys_chargen_h
|sourcemodule=core
}}



Sets the character's core class, including attributes, abilities and stats.

== Remarks ==





== See also ==

Chargen SelectCoreClass

2011-02-28T09:43:49Z

Yokmp: created

{{dafunction
|name=Chargen_SelectCoreClass
|brief=Sets the character's core class.
|param1type=object
|param1name=oChar
|param1desc=The character.
|param1default=
|param2type=int
|param2name=nClass
|param2desc=The ID of the core class (CLASS_*)
|param2default=
|param3type=int
|param3name=bUnApply
|param3desc=TRUE resets the character.
|param3default=FALSE
|returntype=void
|returndesc=
|sourcefile=core_h
|sourcemodule=core
}}



Sets the character's core class, including attributes, abilities and stats.

== Remarks ==





== See also ==

GetCreatureCoreClass

2011-02-28T09:30:57Z

Yokmp:

{{dafunction
|name=GetCreatureCoreClass
|brief=Returns a creature's core class (mage, rogue, warrior)
|param1type=object
|param1name=oCreature
|param1desc=Returns a creature's core class (mage, rogue, warrior)
|param1default=
|returntype=int
|returndesc=Creatures Core Class represents by an integer.
|sourcefile=core_h
|sourcemodule=core
}}




== Remarks ==





== See also ==


[[Category: Object functions]]

GetCreatureCoreClass

2011-02-28T09:12:04Z

Yokmp: created

EffectHeal

2011-02-27T05:19:45Z

Yokmp: created

{{dafunction
|name=EffectHeal
|brief=Returns an effect which heals an object.
|param1type=float
|param1name=fValue
|param1desc=The amount of health.
|param1default=
|param2type=int
|param2name=bIgnoreBloodMagic
|param2desc=Whether or not ignore Blood Magic OR whether or not to resurrect and heal dead creatures (the description is somewhat contradictory).
|param2default=FALSE
|returntype=void
|returndesc=Returns a valid effect of type EFFECT_TYPE_HEALHEALTH
|sourcefile=effect_heal_h
|sourcemodule=
}}

== Description ==

Constructor for the heal health effect.
When applied to an object, this effect restores the given amount of health to the object. The object’s health will not be raised above its maximum health.
If the object is a creature which is dead no health will be healed unless bHealIfDead is TRUE, in which case the creature will be resurrected and healed.

You should take a look at spell_drainlife.nss to see how this works.










[[Category: Effect access functions]]

Engine ApplyEffectOnObject

2011-02-27T04:53:11Z

Yokmp: added param6desc information about dispelling

{{dafunction
|name=Engine_ApplyEffectOnObject
|brief=This function applies an effect on an object.
|param1type=int
|param1name=nDurationType
|param1desc=can be [[EFFECT_DURATION_TYPE_PERMANENT]] [[EFFECT_DURATION_TYPE_INSTANT]] or [[EFFECT_DURATION_TYPE_TEMPORARY]]
|param1default=
|param2type=effect
|param2name=eEffect
|param2desc=the effect to be applied
|param2default=
|param3type=object
|param3name=oTarget
|param3desc=the target of the effect
|param3default=
|param4type=float
|param4name=fDuration
|param4desc=this value needs to be set only when nDurationType is [[EFFECT_DURATION_TYPE_TEMPORARY]]
|param4default=0.0
|param5type=object
|param5name=oCreator
|param5desc=effect creator
|param5default=OBJECT_SELF
|param6type=int
|param6name=nAbilityId
|param6desc=ability ID of the effect (Important for dispelling!)
|param6default=0
|returntype=void
|returndesc=
|sourcefile=script.ldf
|sourcemodule=
}}

== Description ==

Applies eEffect to oTarget. If nDurationType is EFFECT_DURATION_TYPE_TEMPORARY, then fDuration is the duration of the effect. Use core_h.ApplyEffectToObject instead of calling this directly!










[[Category: Effect access functions]]

MaxF

2011-02-27T00:23:46Z

Yokmp: Created

{{dafunction
|name=MaxF
|brief=Returns the greater value of f1 and f2
|param1type = float
|param1name = f1
|param1desc = Float 1
|param1default =
|param2type = float
|param2name = f2
|param2desc = Float 2
|param2default =

|returntype = float
|returndesc = returns the greater value of both
|sourcefile = core.h
|sourcemodule = Core Resources
}}













[[Category:Undocumented]]

MinF

2011-02-27T00:21:49Z

Yokmp: Created

{{dafunction
|name=MinF
|brief=Returns the lesser value of f1 and f2
|param1type = float
|param1name = f1
|param1desc = Float 1
|param1default =
|param2type = float
|param2name = f2
|param2desc = Float 2
|param2default =

|returntype = float
|returndesc = returns the lesser value of both
|sourcefile = core.h
|sourcemodule = Core Resources
}}













[[Category:Undocumented]]