StendhalAPI: Difference between revisions

Jump to navigation Jump to search
Content deleted Content added
imported>AntumDeluge
GuidedEntity: add more public methods
imported>AntumDeluge
GuidedEntity: add more public methods
Line 335: Line 335:


{{PublicMethod | getPathPosition | params= | desc=Retrieves the entity's current position in its path. | ret= | rettype=int | paramlist=}}
{{PublicMethod | getPathPosition | params= | desc=Retrieves the entity's current position in its path. | ret= | rettype=int | paramlist=}}

{{PublicMethod | getGuide | params= | desc= | ret= | rettype=EntityGuide | paramlist=}}

{{PublicMethod | getCollisionAction | params= | desc= | ret= | rettype=CollisionAction | paramlist=}}


{{PublicMethod | hasPath | params= | desc=Checks if the entity has a path set. | ret= | rettype=boolean | paramlist=}}
{{PublicMethod | hasPath | params= | desc=Checks if the entity has a path set. | ret= | rettype=boolean | paramlist=}}
Line 343: Line 347:


{{PublicMethod | reroute | params= | desc=Plan a new path to destination. | ret= | rettype= | paramlist=}}
{{PublicMethod | reroute | params= | desc=Plan a new path to destination. | ret= | rettype= | paramlist=}}

{{PublicMethod | followPath | params= | desc= | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | addSuspend | params=duration, dir, pos... | desc=Add a suspension to the entity's path. | ret= | rettype= | paramlist=
{{MethodParam | duration | type=in | desc=}}
{{MethodParam | dir | type=Direction | desc=(optional)}}
{{MethodParam | pos... | type=int[] | desc=}} }}
: ''NOTE: this method is experimental.''

{{PublicMethod | removeSuspend | params=pos... | desc=Removes a suspension from path. | ret= | rettype= | paramlist=
{{MethodParam | pos... | type=int[] | desc=}} }}
: ''NOTE: this method is experimental.''

{{PublicMethod | onFinishedPath | params= | desc= | ret= | rettype= | paramlist=}}

{{PublicMethod | updateModifedAttributes | params= | desc= | ret= | rettype= | paramlist=}}

{{PublicMethod | atMovementRadius | params= | desc= | ret= | rettype=boolean | paramlist=}}

{{PublicMethod | onOutsideMovementRadius | params= | desc= | ret= | rettype= | paramlist=}}

{{PublicMethod | setRandomMovementRadius | params=radius, ret | desc= | ret= | rettype= | paramlist=
{{MethodParam | radius | type=int | desc=}}
{{MethodParam | ret | type=boolean | desc=(optional)}} }}


== RPEntity ==
== RPEntity ==