Yukar.Engine.MapCharacterMoveMacro Class Reference

Class for automatically moving MapCharacter according to specification More...

Inherited by Yukar.Engine.MapCharacterMoveMacro.SimpleXZTweener, Yukar.Engine.MapCharacterMoveMacro.XZTweener, and Yukar.Engine.MapCharacterMoveMacro.YTweener.

Classes
class	SimpleXZTweener
	XZ movement Tweener of the type that does not match the height (does not rely on physics)
class	XZTweener
	A class that moves the character to the desired XZ coordinates while interpolating the coordinates
class	YTweener
	A class that moves the height of the character while interpolating

Public Types
enum	UsingEasingFunction { Linear = 0 , EaseIn = 1 , EaseOut = 2 }
	the type of easing function to use More...

Static Public Member Functions
static MapCharacterMoveMacro	addYTweener (MapCharacter character, float time, float startY, float targetY, UsingEasingFunction easingMethod, bool toGround, bool checkCollision)
static MapCharacterMoveMacro	addSimpleXZTweener (MapCharacter chr, int dir, float speed, Action finishHandler=null)
static MapCharacterMoveMacro	addXZTweener (MapCharacter chr, int dir, bool shouldKeepMotion, bool fixDir, MapData drawer)
	Add a task to move in the XZ direction (1 step in the specified direction) More...
static MapCharacterMoveMacro	addXZTweener (MapCharacter chr, float x, float y, MapData drawer, Action finishHandler=null)
	Add a task to move in XZ direction (type that specifies the distance to move separately for XZ) More...
static MapCharacterMoveMacro	addXZTweener (MapCharacter self, MapCharacter chr, int dir, bool fixDir, bool abortOnFail, bool through, bool ignoreHeight, bool shouldKeepMotion, float targetDirRad, float totalWalk, bool interpolate, float startDirRad, bool fourDir)
	Add a task to move in the XZ direction (type that specifies orientation and number of steps) More...

Detailed Description

Class for automatically moving MapCharacter according to specification

Member Enumeration Documentation

UsingEasingFunction

enum Yukar.Engine.MapCharacterMoveMacro.UsingEasingFunction

the type of easing function to use

Enumerator
Linear	Constant velocity
EaseIn	acceleration
EaseOut	deceleration

Member Function Documentation

addSimpleXZTweener()

static MapCharacterMoveMacro Yukar.Engine.MapCharacterMoveMacro.addSimpleXZTweener ( MapCharacter  chr, int  dir, float  speed, Action  finishHandler = null  )

static

addXZTweener() [1/3]

static MapCharacterMoveMacro Yukar.Engine.MapCharacterMoveMacro.addXZTweener ( MapCharacter  chr, float  x, float  y, MapData  drawer, Action  finishHandler = null  )

static

Add a task to move in XZ direction (type that specifies the distance to move separately for XZ)

Parameters

chr	Characters to move
x	Movement amount in the X direction
y	Movement amount in the Y direction
drawer	Map data
finishHandler	Complete Handler

Returns

addXZTweener() [2/3]

static MapCharacterMoveMacro Yukar.Engine.MapCharacterMoveMacro.addXZTweener ( MapCharacter  chr, int  dir, bool  shouldKeepMotion, bool  fixDir, MapData  drawer  )

static

Add a task to move in the XZ direction (1 step in the specified direction)

Parameters

chr	Characters to move
dir	Digital or special direction specification (Compatible with Script.MoveType)
shouldKeepMotion	Whether to maintain motion
fixDir	Whether to fix the orientation
drawer	Map data

Returns

addXZTweener() [3/3]

static MapCharacterMoveMacro Yukar.Engine.MapCharacterMoveMacro.addXZTweener ( MapCharacter  self, MapCharacter  chr, int  dir, bool  fixDir, bool  abortOnFail, bool  through, bool  ignoreHeight, bool  shouldKeepMotion, float  targetDirRad, float  totalWalk, bool  interpolate, float  startDirRad, bool  fourDir  )

static

Add a task to move in the XZ direction (type that specifies orientation and number of steps)

Parameters

self	Task execution source (used when dir is Command.MoveType.FOLLOW or ESCAPE)
chr	Characters to move
dir	Digital or special direction specification (Compatible with Script.MoveType)
fixDir	Whether to fix the orientation
abortOnFail	Whether to interrupt if the move fails
through	Whether to slip through obstacles
ignoreHeight	whether to ignore height
shouldKeepMotion	Whether to maintain orientation
targetDirRad	Specification of the radian angle of the direction of movement (used when dir is Command.MoveType.ANY_RAD)
totalWalk	Number of steps traveled
interpolate	Whether to walk with interpolation from the current orientation
startDirRad	Current orientation radian angle specified
fourDir	Whether to round the angle to 90 degrees (used when dir is Command.MoveType.FOLLOW or ESCAPE)

Returns

addYTweener()

static MapCharacterMoveMacro Yukar.Engine.MapCharacterMoveMacro.addYTweener ( MapCharacter  character, float  time, float  startY, float  targetY, UsingEasingFunction  easingMethod, bool  toGround, bool  checkCollision  )

static