GetFactionLeastDamagedMember(object, int)

Get the member of oFactionMember's faction that has taken the fewest hit points of damage.

object GetFactionLeastDamagedMember(
    object oFactionMember = OBJECT_SELF,
    int bMustBeVisible = TRUE
);

Parameters

oFactionMember

The object whose faction to search in. (Default: OBJECT_SELF)

bMustBeVisible

The member chose must be visible to the calling object. (Default: TRUE)

Description

Returns the member of oFactionMember's faction (or Player's party) that has taken the fewest hit points of damage. If bMustBeVisible is set to TRUE (default) then the least damaged member must be visible to the object who is doing the search.

Returns OBJECT_INVALID if oFactionMember's faction is invalid.

Remarks

Great function for determing who the bad guys will target in a fight. If you want a fight to last as long as possible, riddle your AI's with this so they are retargeting according to who can take the damage. Good way to draw a fight out and give the party a chance for survival, yet at the same time making sure everyone feels some pain.

Note, however, that because usually PC parties are normally healed fully, that at the beginnings of fights using this function, it may be only one PC is kept on being targeted - easy for PC's to then counter this.

This will work exactly the same was as using GetFirst/NextFactionMemeber() and using GetMaxHitPoints() Minus GetCurrentHitPoints() (If not, please e-mail in), to find the highest, only is much easier to code and probably better on performance.

Try to never use this on an NPC faction unless bMustBeVisible is TRUE, because NPC factions usually have dozens of NPC's, and thus may cause a lot of high CPU usage with faction calls such as this.

Version

1.62

Example

// Get the most health PC and attack them. For all it matters, this
// could be the On Heartbeat script of a NPC.

void main()
{
    // Get nearest PC
    object oPC = GetNearestCreature(CREATURE_TYPE_PLAYER_CHAR, PLAYER_CHAR_IS_PC);

    // Get least damaged
    object oLeastDamaged = GetFactionLeastDamagedMember(oFactionMember, TRUE);

    // Attack them
    if(GetIsObjectValid(oLeastDamaged))
    {
        ClearAllActions();
        ActionAttack(oLeastDamaged);
    }
}