PlayerWrapper

class Player.PlayerWrapper(object: Object)

Базовые классы: Object

class MovementType

Базовые классы: object

Locomotion: Any = Ellipsis

Движение

Teleport: Any = Ellipsis

Телепортацию

All: Any = Ellipsis

Любое перемещение

class RotationTypes

Базовые классы: object

ToObject: Any = Ellipsis

К объекту

SameAsObject: Any = Ellipsis

Так же, как

class Gravity

Базовые классы: object

GravityOn: Any = Ellipsis

Подчиняется гравитации

GravityOff: Any = Ellipsis

Не подчиняется гравитации

class SwitchStateTypes

Базовые классы: object

Enabled: Any = Ellipsis

Включено

Disabled: Any = Ellipsis

Выключено

class AllowedStates

Базовые классы: object

Allowed: Any = Ellipsis

Разрешено

Prohibited: Any = Ellipsis

Запрещено

class VibrationPreset

Базовые классы: object

Weak: Any = Ellipsis

Слабо

Strong: Any = Ellipsis

Сильно

class PlayerHand

Базовые классы: object

RightHand: Any = Ellipsis

Правая рука

LeftHand: Any = Ellipsis

Левая рука

BothHands: Any = Ellipsis

Обе руки

property WalkingSpeed: float

Cкорость ходьбы в режиме просмотра на ПК [value] м/с

Пример:

value = instance.WalkingSpeed

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property SprintSpeed: float

Скорость бега [value] м/с

Пример:

value = instance.SprintSpeed

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property JumpHeight: float

Высота прыжка [value] м

Пример:

value = instance.JumpHeight

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property PlayerNormalHeight: float

Высота игрока в режиме просмотра на ПК [value] м

Пример:

value = instance.PlayerNormalHeight

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property UseGravity: Any

Физическое свойство

Результат:

значение из перечня:

• PlayerWrapper.Gravity.GravityOn

• PlayerWrapper.Gravity.GravityOff

Пример:

value = instance.UseGravity

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property IsArcIsHiddenOnDisabledTeleport: bool

Скрывать луч при отключённом телепорте

Пример:

value = instance.IsArcIsHiddenOnDisabledTeleport

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property CursorIsVisible: Any

Отображение курсора в режиме Desktop

Результат:

значение из перечня:

• PlayerWrapper.SwitchStateTypes.Enabled

• PlayerWrapper.SwitchStateTypes.Disabled

Пример:

value = instance.CursorIsVisible

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property IsMouseLookEnabled: Any

Поворот камеры с помощью мыши в режиме Desktop

Результат:

значение из перечня:

• PlayerWrapper.AllowedStates.Allowed

• PlayerWrapper.AllowedStates.Prohibited

Пример:

value = instance.IsMouseLookEnabled

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property IsTurnInVREnabled: Any

Поворот в VR с помощью контроллера

Результат:

значение из перечня:

• PlayerWrapper.AllowedStates.Allowed

• PlayerWrapper.AllowedStates.Prohibited

Пример:

value = instance.IsTurnInVREnabled

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property ObjectInteraction: Any

Взаимодействие с объектами

Результат:

значение из перечня:

• PlayerWrapper.AllowedStates.Allowed

• PlayerWrapper.AllowedStates.Prohibited

Пример:

value = instance.ObjectInteraction

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property HeadPosition: Vector3

Положение головы

Пример:

value = instance.HeadPosition

property HeadRotation: Vector3

Вращение головы

Пример:

value = instance.HeadRotation

property PointerLength: float

Длина луча указки

Пример:

value = instance.PointerLength

property AlwaysDrawRay: bool

Постоянно отображать луч указателя

Пример:

value = instance.AlwaysDrawRay

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property BeginWidth: float

Начальная ширина луча указки [value] м

Пример:

value = instance.BeginWidth

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property EndWidth: float

Конечная ширина луча указки [value] м

Пример:

value = instance.EndWidth

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property BeginColor: Color

Начальный цвет луча указки [value]

Пример:

value = instance.BeginColor

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property EndColor: Color

Конечный цвет луча указки [value]

Пример:

value = instance.EndColor

Предупреждение

При использовании может возникнуть исключение AttributeError, если геттер не был реализован.

property HandsRadius: float

Радиус коллайдера рук

Пример:

value = instance.HandsRadius

CheckHoldAnyObject() → bool

Держит в руках какой-нибудь объект

Пример:

value = instance.CheckHoldAnyObject()

CheckObjectInAnyHand(otherObject: Object) → bool

Держит в какой-либо из рук

Параметры:

(Object) (otherObject) – объект сцены

Пример:

value = instance.CheckObjectInAnyHand(sceneObject)

CheckObjectInLeftHand(otherObject: Object) → bool

Держит в левой руке

Параметры:

(Object) (otherObject) – объект сцены

Пример:

value = instance.CheckObjectInLeftHand(sceneObject)

CheckObjectInRightHand(otherObject: Object) → bool

Держит в правой руке

Параметры:

(Object) (otherObject) – объект сцены

Пример:

value = instance.CheckObjectInRightHand(sceneObject)

AllowMovementEverywhere() → None

Может двигаться везде

Пример:

instance.AllowMovementEverywhere()

AllowMovementOnlyTeleportArea() → None

Может двигаться по области перемещения

Пример:

instance.AllowMovementOnlyTeleportArea()

AllowMovementType(type: int) → None

Разрешить

Параметры:

(int) (type) –

значение из перечня:

• PlayerWrapper.MovementType.Locomotion

• PlayerWrapper.MovementType.Teleport

• PlayerWrapper.MovementType.All

Пример:

instance.AllowMovementType(PlayerWrapper.MovementType.Locomotion)

ProhibitMovementType(type: int) → None

Запретить

Параметры:

(int) (type) –

значение из перечня:

• PlayerWrapper.MovementType.Locomotion

• PlayerWrapper.MovementType.Teleport

• PlayerWrapper.MovementType.All

Пример:

instance.ProhibitMovementType(PlayerWrapper.MovementType.Locomotion)

TeleportToStartPosition() → None

Вернуть в начальную позицию

Пример:

instance.TeleportToStartPosition()

TeleportToObject(targetObj: Object) → None

Телепортироваться к объекту

Параметры:

(Object) (targetObj) – объект сцены

Пример:

instance.TeleportToObject(sceneObject)

TeleportToVector(targetVector: Vector3) → None

Телепортироваться к координатам

Пример:

instance.TeleportToVector(Varwin.Vector3(1,1,1))

async MoveToPointWithSpeed(target: Vector3, speed: float) → None

Перемещаться к координатам [target] со скоростью [speed] м/с

Пример:

await instance.MoveToPointWithSpeed(Varwin.Vector3(1,1,1), 0)

async MoveToObjectWithSpeed(targetWrapper: Object, speed: float) → None

Перемещаться к объекту [targetWrapper] со скоростью [speed] м/с

Параметры:

(Object) (targetWrapper) – объект сцены

Пример:

await instance.MoveToObjectWithSpeed(sceneObject, 0)

RotateHorizontally(angle: float) → None

Мгновенно повернуться в горизонтальной плоскости на [angle] градусов

Пример:

instance.RotateHorizontally(0)

RotateTo(rotationTapes: int, target: Object) → None

Мгновенно повернуться

Параметры:

• (int) (rotationTapes) –

  значение из перечня:

  • PlayerWrapper.RotationTypes.ToObject

  • PlayerWrapper.RotationTypes.SameAsObject

• (Object) (target) – объект сцены

Пример:

instance.RotateTo(PlayerWrapper.RotationTypes.ToObject, sceneObject)

SetEulerAngles(targetAngle: Vector3) → None

Задать поворот

Пример:

instance.SetEulerAngles(Varwin.Vector3(1,1,1))

ForceGrabObjectInLeftHand(otherObject: Object) → None

Принудительно взять в левую руку

Параметры:

(Object) (otherObject) – объект сцены

Пример:

instance.ForceGrabObjectInLeftHand(sceneObject)

ForceGrabObjectInRightHand(otherObject: Object) → None

Принудительно взять в правую руку

Параметры:

(Object) (otherObject) – объект сцены

Пример:

instance.ForceGrabObjectInRightHand(sceneObject)

async ForceDropFromBothHands() → None

Принудительно выпустить объекты из обеих рук

Пример:

await instance.ForceDropFromBothHands()

async ForceDropObjectInLeftHand() → None

Принудительно выпустить объект из левой руки

Пример:

await instance.ForceDropObjectInLeftHand()

async ForceDropObjectInRightHand() → None

Принудительно выпустить объект из правой руки

Пример:

await instance.ForceDropObjectInRightHand()

VibrateLeftHand(strength: float, duration: float) → None

Завибрировать с настройками для левой руки с силой [0..1] [strength] продолжительностью [duration] с.

Пример:

instance.VibrateLeftHand(0, 0)

VibrateRightHand(strength: float, duration: float) → None

Завибрировать с настройками для правой руки с силой [0..1] [strength] продолжительностью [duration] с.

Пример:

instance.VibrateRightHand(0, 0)

VibrateLeftHandPreset(vibrationPreset: int) → None

Завибрировать для левой руки с интенсивностью [vibrationPreset]

Параметры:

(int) (vibrationPreset) –

значение из перечня:

• PlayerWrapper.VibrationPreset.Weak

• PlayerWrapper.VibrationPreset.Strong

Пример:

instance.VibrateLeftHandPreset(PlayerWrapper.VibrationPreset.Weak)

VibrateRightHandPreset(vibrationPreset: int) → None

Завибрировать для правой руки с интенсивностью [vibrationPreset]

Параметры:

(int) (vibrationPreset) –

значение из перечня:

• PlayerWrapper.VibrationPreset.Weak

• PlayerWrapper.VibrationPreset.Strong

Пример:

instance.VibrateRightHandPreset(PlayerWrapper.VibrationPreset.Weak)

async VibrateWithIntervals(hand: int, strength: float, duration: float, interval: float, vibrationCount: int) → None

Завибрировать для [hand] с силой [0..1] [strength] продолжительностью вибрации [duration] с. интервалом [interval] с. количеством вибраций [vibrationCount]

Параметры:

(int) (hand) –

значение из перечня:

• PlayerWrapper.PlayerHand.RightHand

• PlayerWrapper.PlayerHand.LeftHand

• PlayerWrapper.PlayerHand.BothHands

Пример:

await instance.VibrateWithIntervals(PlayerWrapper.PlayerHand.RightHand, 0, 0, 0, 0)

AttachCameraToObject(target: Object, positionOffset: Vector3, rotationOffset: Vector3) → None

Закрепить камеру за объектом [target] со смещением позиции [positionOffset] поворота [rotationOffset]

Параметры:

(Object) (target) – объект сцены

Пример:

instance.AttachCameraToObject(sceneObject, Varwin.Vector3(1,1,1), Varwin.Vector3(1,1,1))

DetachCameraFromObject() → None

Открепить камеру от объекта

Пример:

instance.DetachCameraFromObject()

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

Рука столкнулась [hand] с объектом [wrapperObject]

Параметры:

handler –

Асинхронная функция-обработчик с сигнатурой:

• hand (Any): hand

• wrapperObject (Object): объект сцены

• sender (Object): объект, который вызвал событие

Пример:

async def OnAnyHandCollided(hand, wrapperObject, sender):
  pass
instance.AddAnyHandCollidedHandler(OnAnyHandCollided)

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

Контроллер включен

Параметры:

handler –

Асинхронная функция-обработчик с сигнатурой:

• hand (Any): hand

• sender (Object): объект, который вызвал событие

Пример:

async def OnControllerEnabled(hand, sender):
  pass
instance.AddControllerEnabledHandler(OnControllerEnabled)

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

Контроллер выключен

Параметры:

handler –

Асинхронная функция-обработчик с сигнатурой:

• hand (Any): hand

• sender (Object): объект, который вызвал событие

Пример:

async def OnControllerDisabled(hand, sender):
  pass
instance.AddControllerDisabledHandler(OnControllerDisabled)