VBotBoyWrapper

class VBotBoy.VBotBoyWrapper(object: Object)

Bases: Object

class RotationDirection

Bases: object

Clockwise: Any = Ellipsis

Clockwise

Counterclockwise: Any = Ellipsis

Counterclockwise

class MovementDirection

Bases: object

Forward: Any = Ellipsis

Forward

Backward: Any = Ellipsis

Backward

Left: Any = Ellipsis

Left

Right: Any = Ellipsis

Right

class MovementPace

Bases: object

Walk: Any = Ellipsis

Walking

Run: Any = Ellipsis

Running

class TextBubbleHideType

Bases: object

Automatic: Any = Ellipsis

Automatic

Never: Any = Ellipsis

Never

SetMaxTraversableSlope(slope: float) → None

Set max traversable slope angle

Example:

instance.SetMaxTraversableSlope(0)

SetMaxStepHeight(slope: float) → None

Set max step height

Example:

instance.SetMaxStepHeight(0)

SetMinObjectDistance(objectDistance: float) → None

Set object stop distance

Example:

instance.SetMinObjectDistance(0)

async RotateByAngle(angle: float, rotationDirection: int, time: float) → None

Rotate for [angle] degrees [rotationDirection] in [time] sec

Parameters:

(int) (rotationDirection) –

value from the list:

• VBotBoyWrapper.RotationDirection.Clockwise

• VBotBoyWrapper.RotationDirection.Counterclockwise

Example:

await instance.RotateByAngle(0, VBotBoyWrapper.RotationDirection.Clockwise, 0)

MoveInfinite(movementDirection: int, movementPace: int) → None

Move [movementDirection] at [movementPace] pace until stopped

Parameters:

• (int) (movementPace) –

  value from the list:

  • VBotBoyWrapper.MovementDirection.Forward

  • VBotBoyWrapper.MovementDirection.Backward

  • VBotBoyWrapper.MovementDirection.Left

  • VBotBoyWrapper.MovementDirection.Right

• (int) –

  value from the list:

  • VBotBoyWrapper.MovementPace.Walk

  • VBotBoyWrapper.MovementPace.Run

Example:

instance.MoveInfinite(VBotBoyWrapper.MovementDirection.Forward, VBotBoyWrapper.MovementPace.Walk)

async MoveByMeters(movementDirection: int, movementPace: int, distance: float) → None

Move [movementDirection] at [movementPace] pace for [distance] m

Parameters:

• (int) (movementPace) –

  value from the list:

  • VBotBoyWrapper.MovementDirection.Forward

  • VBotBoyWrapper.MovementDirection.Backward

  • VBotBoyWrapper.MovementDirection.Left

  • VBotBoyWrapper.MovementDirection.Right

• (int) –

  value from the list:

  • VBotBoyWrapper.MovementPace.Walk

  • VBotBoyWrapper.MovementPace.Run

Example:

await instance.MoveByMeters(VBotBoyWrapper.MovementDirection.Forward, VBotBoyWrapper.MovementPace.Walk, 0)

async MoveToObject(movementPace: int, wrapper: Object) → None

Move at [movementPace] pace towards object [wrapper]

Parameters:

• (int) (movementPace) –

  value from the list:

  • VBotBoyWrapper.MovementPace.Walk

  • VBotBoyWrapper.MovementPace.Run

• (Object) (wrapper) – scene object

Example:

await instance.MoveToObject(VBotBoyWrapper.MovementPace.Walk, sceneObject)

async MoveAlongPath(movementPace: int, points: Any) → None

Move at [movementPace] pace along the path [points]

Parameters:

(int) (movementPace) –

value from the list:

• VBotBoyWrapper.MovementPace.Walk

• VBotBoyWrapper.MovementPace.Run

Example:

await instance.MoveAlongPath(VBotBoyWrapper.MovementPace.Walk, 0)

PausePath() → None

Pause movement along the path

Example:

instance.PausePath()

ContinuePath() → None

Continue movement along the path

Example:

instance.ContinuePath()

StopMovement() → None

Stop motion

Example:

instance.StopMovement()

SetShowTextBubbleHideType(hideType: int) → None

Set text bubble hide type

Parameters:

(int) (hideType) –

value from the list:

• VBotBoyWrapper.TextBubbleHideType.Automatic

• VBotBoyWrapper.TextBubbleHideType.Never

Example:

instance.SetShowTextBubbleHideType(VBotBoyWrapper.TextBubbleHideType.Automatic)

SetShowTextBubble(show: bool) → None

Set text bubble enabled

Example:

instance.SetShowTextBubble(False)

SayText(text: str) → None

Say

Example:

instance.SayText("text")

SayTextWith(header: str, text: str) → None

Say header: [header] text: [text]

Example:

instance.SayTextWith("text", "text")

StopSpeaking() → None

Stop speaking

Example:

instance.StopSpeaking()

AddBotTargetReachedHandler(handler: Callable[[Object, Object], CoroutineType]) → None

Target object reached

Parameters:

handler –

Asynchronous handler function with signature:

• target (Object): scene object

• sender (Object): the object that triggered the event

Example:

async def OnBotTargetReached(target, sender):
  pass
instance.AddBotTargetReachedHandler(OnBotTargetReached)

AddBotPathPointReachedHandler(handler: Callable[[int, Object, Object], CoroutineType]) → None

Path point reached

Parameters:

handler –

Asynchronous handler function with signature:

• id (int): id

• point (Object): scene object

• sender (Object): the object that triggered the event

Example:

async def OnBotPathPointReached(id, point, sender):
  pass
instance.AddBotPathPointReachedHandler(OnBotPathPointReached)

AddSpeechCompletedHandler(handler: Callable[[Object], CoroutineType]) → None

On speech completed

Parameters:

handler –

Asynchronous handler function with signature:

• sender (Object): the object that triggered the event

Example:

async def OnSpeechCompleted(sender):
  pass
instance.AddSpeechCompletedHandler(OnSpeechCompleted)