GetMovementRate(object)

Returns the movement rate of a game being

int GetMovementRate(
    object oCreature
);

Parameters

oCreature

Being whose movement rate to return


Description

Gets the movement rate of a being, either a PC or an NPC. The possible return values are:

0 = PC Movement Speed or invalid oCreature
1 = Immobile
2 = Very Slow
3 = Slow
4 = Normal
5 = Fast
6 = Very Fast
7 = Creature Default (defined in appearance.2da)
8 = DM Speed



Remarks

This cannot be used to determine if a PC is walking or running as a PC always returns a value of 0.


Version

1.22

See Also

categories: Get Data from Creature Functions


 author: Drake Coker
 Send comments on this topic.