StendhalAPI: Difference between revisions
Content deleted Content added
imported>AntumDeluge →GuidedEntity: add some public methods |
imported>AntumDeluge →GuidedEntity: add more public methods |
||
Line 315:
{{MethodParam| bs | type=double | desc=New normal speed for moving.}} }}
{{PublicMethod | setPath | params=path, position | desc=Set a path for this entity to follow. | ret= | rettype= | paramlist=
{{MethodParam| path | type=FixedPath | desc=Path to follow.
{{MethodParam| position | type=int | desc=(optional) The position of the path where the entity should start (this is not the same as <code>setPosition()</code>).}} }}
{{PublicMethod | setPathAndPosition | params=path | desc=Set path & starting position for entity. | ret= | rettype= | paramlist=
{{MethodParam| path | type=FixedPath | desc=Path to follow.}} }}
{{PublicMethod | setPathPosition | params=pathPos | desc=Sets the entity's position in its path. | ret= | rettype= | paramlist=
{{MethodParam| pathPos | type=int | desc=Position to set.}} }}
{{PublicMethod | retracePath | params= | desc=Causes entity to retrace its path backwards when it reaches the end. | ret= | rettype= | paramlist=}}
{{PublicMethod | setCollisionAction | params=action | desc=Set action type to take when entity collides. | ret= | rettype= | paramlist=
{{MethodParam| action | type=CollisionAction | desc=Behavior type after collision.}} }}
{{PublicMethod | getBaseSpeed | params= | desc=Retreives entity's normal movement speed. | ret= | rettype=double | paramlist=}}
{{PublicMethod | getPath | params= | desc=Retrieves the entity's current path. | ret= | rettype=FixedPath | paramlist=}}
{{PublicMethod | getPathPosition | params= | desc=Retrieves the entity's current position in its path. | ret= | rettype=int | paramlist=}}
{{PublicMethod | hasPath | params= | desc=Checks if the entity has a path set. | ret= | rettype=boolean | paramlist=}}
{{PublicMethod | isPathLoop | params= | desc=Checks if the entity's path loops. | ret= | rettype=boolean | paramlist=}}
{{PublicMethod | clearPath | params= | desc=Removes the entity's path. | ret= | rettype= | paramlist=}}
{{PublicMethod | reroute | params= | desc=Plan a new path to destination. | ret= | rettype= | paramlist=}}
== RPEntity ==
| |||