Yukar.Engine.ScriptRunner Class Reference

Event content execution class More...

Public Types
enum	ScriptState { Stopped , Paused , Running , DeepPaused }
	the current execution state of this ScriptRunner More...
enum	RemoveTrigger { NONE , ON_EXIT , ON_COMPLETE_CURRENT_LINE }
	Specify the timing to automatically destroy the currently running ScriptRunner More...
enum	SpinType {   NONE , NEAR , LEFT , RIGHT ,   X_ONLY }
	Rotation direction specification of the old camera rotation panel More...
enum	PosType { PLAYER , EVENT , SPOT }
	Gaze point designation of the old camera coordinate panel More...
enum	HeroStatusType {   HITPOINT , MAGICPOINT , ATTACKPOWER , DEFENSE ,   MAGIC , SPEED }
	Status type to get More...

Public Member Functions
bool	isParallelTriggers (bool includeMoveScript=false)
bool	isEffectTriggers ()
bool	isFixedUpdateTriggers ()
	ScriptRunner (MapScene owner, MapCharacter mapChr, Script script, Guid inId, RomItem parentRom=null)
	ScriptRunner (MapScene owner, MapCharacter mapChr, Script script, RomItem parentRom=null)
float	GetFloatOrVariable (Script.Attr attr, bool legacyMode=true)
	get the value of a variable In this variation, if IntAttr is included, it is obtained as a numerical value as it is More...
double	GetNumOrVariable (Script.Attr attr)
	get the value of a variable In this variation, if IntAttr is included, it is obtained as a numerical value as it is More...
bool	Run ()
void	finalize ()
void	UnlockControl ()
bool	Update ()
bool	isFinished ()
void	AddFinalizer (Action finalizer)
void	SetWaiter (Func< bool > waiter)

Static Public Member Functions
static Stack< int >	CopyStack (Stack< int > source)
static double	GetNumOrVariable (GameMain owner, Guid evGuid, Script.Attr attr, bool isDynamic)
	get the value of a variable In this variation, if IntAttr is included, it is obtained as a numerical value as it is More...
static double	GetVariable (GameMain owner, Guid evGuid, Script.Attr attr, bool isDynamic)
	get the value of a variable This variation interprets IntAttr as an SGB1 compatible numeric type variable More...
static Func< bool >	AddBlendShapeTask (MapCharacter tgt, string clipName, float time, bool doReset)
static int	getStatus (Common.GameData.Hero battleStatus, Guid statusId, bool totalStatus)
static int	getBattleStatus (BattleCharacterBase battleStatus, Command.VarHeroSourceType srcTypePlus, Guid option, List< BattlePlayerData > party)
static int	getBattleStatus (BattleCharacterBase battleStatus, Guid statusId)
static Func< bool >	CreateShakeFunc (int force, float waitFrame, MapScene owner, Action< SharpKmyMath.Vector2 > shakeValueHandler=null)
static int	calcDir (MapCharacter tgt, MapCharacter chr, bool reverse=false, bool anyRad=false)
static int	calcDirImpl (float dx, float dz)

Public Attributes
MapCharacter	mapChr
MapScene	owner
ScriptState	state = ScriptState.Stopped
RemoveTrigger	removeTrigger = RemoveTrigger.NONE
Guid	key

Properties
Script.Trigger	Trigger [get]

Detailed Description

Event content execution class

Member Enumeration Documentation

HeroStatusType

enum Yukar.Engine.ScriptRunner.HeroStatusType

Status type to get

Enumerator
HITPOINT
MAGICPOINT
ATTACKPOWER
DEFENSE
MAGIC
SPEED

PosType

enum Yukar.Engine.ScriptRunner.PosType

Gaze point designation of the old camera coordinate panel

Enumerator
PLAYER
EVENT
SPOT

RemoveTrigger

enum Yukar.Engine.ScriptRunner.RemoveTrigger

Specify the timing to automatically destroy the currently running ScriptRunner

Enumerator
NONE
ON_EXIT
ON_COMPLETE_CURRENT_LINE

ScriptState

enum Yukar.Engine.ScriptRunner.ScriptState

the current execution state of this ScriptRunner

Enumerator
Stopped
Paused
Running
DeepPaused

SpinType

enum Yukar.Engine.ScriptRunner.SpinType

Rotation direction specification of the old camera rotation panel

Enumerator
NONE
NEAR
LEFT
RIGHT
X_ONLY

Constructor & Destructor Documentation

ScriptRunner() [1/2]

Yukar.Engine.ScriptRunner.ScriptRunner	(	MapScene	owner,
		MapCharacter	mapChr,
		Script	script,
		Guid	inId,
		RomItem	parentRom = null
	)

ScriptRunner() [2/2]

Yukar.Engine.ScriptRunner.ScriptRunner	(	MapScene	owner,
		MapCharacter	mapChr,
		Script	script,
		RomItem	parentRom = null
	)

Member Function Documentation

AddBlendShapeTask()

static Func< bool > Yukar.Engine.ScriptRunner.AddBlendShapeTask ( MapCharacter  tgt, string  clipName, float  time, bool  doReset  )

static

AddFinalizer()

void Yukar.Engine.ScriptRunner.AddFinalizer

(

Action

finalizer

)

calcDir()

static int Yukar.Engine.ScriptRunner.calcDir ( MapCharacter  tgt, MapCharacter  chr, bool  reverse = false, bool  anyRad = false  )

static

calcDirImpl()

static int Yukar.Engine.ScriptRunner.calcDirImpl ( float  dx, float  dz  )

static

CopyStack()

static Stack< int > Yukar.Engine.ScriptRunner.CopyStack ( Stack< int >  source )

static

CreateShakeFunc()

static Func< bool > Yukar.Engine.ScriptRunner.CreateShakeFunc ( int  force, float  waitFrame, MapScene  owner, Action< SharpKmyMath.Vector2 >  shakeValueHandler = null  )

static

finalize()

void Yukar.Engine.ScriptRunner.finalize

(

)

getBattleStatus() [1/2]

static int Yukar.Engine.ScriptRunner.getBattleStatus ( BattleCharacterBase  battleStatus, Command.VarHeroSourceType  srcTypePlus, Guid  option, List< BattlePlayerData >  party  )

static

getBattleStatus() [2/2]

static int Yukar.Engine.ScriptRunner.getBattleStatus ( BattleCharacterBase  battleStatus, Guid  statusId  )

static

GetFloatOrVariable()

float Yukar.Engine.ScriptRunner.GetFloatOrVariable	(	Script.Attr	attr,
		bool	legacyMode = true
	)

get the value of a variable In this variation, if IntAttr is included, it is obtained as a numerical value as it is

Parameters

attr
legacyMode	whether to treat int as fixed decimal (1/1000)

Returns

GetNumOrVariable() [1/2]

static double Yukar.Engine.ScriptRunner.GetNumOrVariable ( GameMain  owner, Guid  evGuid, Script.Attr  attr, bool  isDynamic  )

static

get the value of a variable In this variation, if IntAttr is included, it is obtained as a numerical value as it is

Parameters

owner
evGuid
attr
isDynamic

Returns

GetNumOrVariable() [2/2]

double Yukar.Engine.ScriptRunner.GetNumOrVariable

(

Script.Attr

attr

)

get the value of a variable In this variation, if IntAttr is included, it is obtained as a numerical value as it is

Parameters

attr

Returns

getStatus()

static int Yukar.Engine.ScriptRunner.getStatus ( Common.GameData.Hero  battleStatus, Guid  statusId, bool  totalStatus  )

static

GetVariable()

static double Yukar.Engine.ScriptRunner.GetVariable ( GameMain  owner, Guid  evGuid, Script.Attr  attr, bool  isDynamic  )

static

get the value of a variable This variation interprets IntAttr as an SGB1 compatible numeric type variable

Parameters

attr

Returns

isEffectTriggers()

bool Yukar.Engine.ScriptRunner.isEffectTriggers

(

)

isFinished()

bool Yukar.Engine.ScriptRunner.isFinished

(

)

isFixedUpdateTriggers()

bool Yukar.Engine.ScriptRunner.isFixedUpdateTriggers

(

)

isParallelTriggers()

bool Yukar.Engine.ScriptRunner.isParallelTriggers

(

bool

includeMoveScript = false

)

Run()

bool Yukar.Engine.ScriptRunner.Run

(

)

SetWaiter()

void Yukar.Engine.ScriptRunner.SetWaiter

(

Func< bool >

waiter

)

UnlockControl()

void Yukar.Engine.ScriptRunner.UnlockControl

(

)

Update()

bool Yukar.Engine.ScriptRunner.Update

(

)

Member Data Documentation

key

Guid Yukar.Engine.ScriptRunner.key

mapChr

MapCharacter Yukar.Engine.ScriptRunner.mapChr

owner

MapScene Yukar.Engine.ScriptRunner.owner

removeTrigger

RemoveTrigger Yukar.Engine.ScriptRunner.removeTrigger = RemoveTrigger.NONE

state

ScriptState Yukar.Engine.ScriptRunner.state = ScriptState.Stopped

Property Documentation

Trigger

Script.Trigger Yukar.Engine.ScriptRunner.Trigger

get