Wiki-home » About VastPark » Platform » VastWorlds platform » Developer's guide » Plugins » List of Plugins »

AvatarPlugin

IMML example

<Plugin Name="AvatarController" Enabled="False" Source="http://id.vastpark.com/VastParkWS/get.vpws?publisher=craigomatic&amp;name=AvatarPlugin&amp;domain=vastpark&amp;context=park">
    <Parameter Key="AnimationSource" Value="http://vp.animation.s3.amazonaws.com/avataranim.zip"/>
    <Parameter Key="UseModelProperties" Value="False"/>
    <Parameter Key="Radius" Value="0.8"/>
    <Parameter Key="ForwardsKey" Value="Up"/>
    <Parameter Key="BackwardsKey" Value="Down"/>
    <Parameter Key="LeftKey" Value="Left"/>
    <Parameter Key="RightKey" Value="Right"/>
    <Parameter Key="RunKey" Value="RightShift"/>
    <Parameter Key="AltForwardsKey" Value="W"/>
    <Parameter Key="AltBackwardsKey" Value="S"/>
    <Parameter Key="AltLeftKey" Value="A"/>
    <Parameter Key="AltRightKey" Value="D"/>
    <Parameter Key="AltRunKey" Value="LeftShift"/>
</Plugin>

Properties

string AnimationSource

  • Summary: Gets or sets the primary animation source to be used

bool SuppressInput

  • Summary:

bool DisableUserInput

  • Summary:

bool FirstPerson

  • Summary:

bool DisableJump

  • Summary: Disables jump

bool LockMouseOnClick

  • Summary: Locks the mouse to the centre of the screen when clicked

bool Strafe

  • Summary: When true, the left and right keys strafe rather than turn

string ForwardsKey

  • Summary:

string BackwardsKey

  • Summary:

string RightKey

  • Summary:

string LeftKey

  • Summary:

string RunKey

  • Summary:

string JumpKey

  • Summary:

string AltForwardsKey

  • Summary:

string AltBackwardsKey

  • Summary:

string AltLeftKey

  • Summary:

string AltRightKey

  • Summary:

string AltRunKey

  • Summary:

string AltJumpKey

  • Summary:

string Head

  • Summary: the section for gestures and stuff

string HeadMouseDriven

  • Summary:

string HeadMultiplier

  • Summary:

Vector3 LookAtVector

  • Summary:

string EyeLevel

  • Summary: The eye level to use for the FPS camera

string Avatar

  • Summary: The name of the element that should be linked to input movements

string FirstPersonCamera

  • Summary: The name of the camera to use when in first person mode

string ThirdPersonCamera

  • Summary: The name of the camera to use when in 3rd person mode

string Crosshair

  • Summary: The name of the text element that's acting as the crosshair (optional, only used during first person mode)

float Weight

  • Summary: The weight of the physics proxy to create

float Height

  • Summary: The height of the physics proxy to create

float Radius

  • Summary: The radius of the physics proxy to create

float JumpImpulse

  • Summary:

bool LimitJumpMovement

  • Summary:

bool UseModelProperties

  • Summary: When true, uses the properties specified in the model as the values to apply for the plugin

float MouseSensitivity

  • Summary: Mouse sensitiviy between 0 and 1

float RunMultiplier

  • Summary:

float WalkSpeed

  • Summary:

ILogProvider LogProvider

  • Summary:

IBoneNodeUpdater BoneNodeUpdater

  • Summary:

IAnimationSystem AnimationSystem

  • Summary:

IInputController InputController

  • Summary:

ICameraController CameraController

  • Summary:

INetworkController NetworkController

  • Summary:

ICommandExecuter<IPluginCommand, PluginCommandType> CommandExecutor

  • Summary:

AnimationController LocalLixaController

  • Summary: Gets the local Lixa controller

bool IsSeated

  • Summary:

bool Enabled

  • Summary: Gets or sets the enabled state of the plugin

Functions

void Load()

  • Summary:
  • Parameters

void AddElement(ImmlElement element)

  • Summary:
  • Parameters

string GetOverrideAnimation(string targetGroup)

  • Summary: Gets the current override animation for the specified target group
  • Parameters
    • targetGroup:
  • Returns:

void SetDefaultAnimation(string targetSequence)

  • Summary: Sets the default animation target sequence
  • Parameters
    • targetSequence:

void SetOverrideAnimation(string targetGroup, string targetSequence, bool loop)

  • Summary: Sets the override animation sequence for a specific group
  • Parameters
    • targetGroup:
    • targetSequence:
    • loop:

void SetLocation(Vector3 position, Vector3 rotation)

  • Summary:
  • Parameters

void Sit()

  • Summary:
  • Parameters

void Stand(Vector3 position, Vector3 rotation)

  • Summary:
  • Parameters

void Sit(VastPark.Imml.Proxy.ImmlElement elementProxy)

  • Summary:
  • Parameters

void Stand()

  • Summary:
  • Parameters

void Update()

  • Summary: Updates the plugin. For internal framework use only
  • Parameters

void Dispose()

  • Summary: Disposes of resources used by the plugin. For internal framework use only.
  • Parameters

void SetParkEngine(IParkEngine parkEngine)

  • Summary: Sets the internally used IParkEngine instance. For internal framework use only
  • Parameters
    • parkEngine: