Yukar.Common.Rom.Event Class Reference

Class that holds event information More...

Inheritance diagram for Yukar.Common.Rom.Event:

Classes
class	Condition
	seat conditions More...
class	Property
	Unused More...
class	Property2
	Property 2 Extension property Because the first Property may disappear. More...
class	ScriptBinder
	A class that compiles binding information for C# scripts More...
class	Sheet
	event sheet More...

Public Types
enum	Priority { UNDER , EQUAL , OVER }
	Priority More...
enum	MoveType { NONE , RANDOM , FOLLOW , ESCAPE }
	movement type More...
Public Types inherited from Yukar.Common.Rom.RomItem
enum	ThumbnailStatusType { Empty = 0 , Creating , Created , Failed }
	Thumbnail image generation status More...

Public Member Functions
Sheet	getSheet (Guid guid)
	Get sheet More...
bool	IsValid ()
	Is this event valid? More...
	Event ()
	constructor More...
override void	save (System.IO.BinaryWriter writer)
override void	load (System.IO.BinaryReader reader)
override bool	initializingAfterLoading ()
	Initialization process after loading More...
void	addNewSheet (Catalog catalog, string name, Common.Rom.Script.Trigger trigger=Script.Trigger.TALK)
	add new sheet More...
void	saveToText (System.IO.StreamWriter writer)
	Save as text More...
bool	tryLoadFromText (System.IO.StreamReader reader, List< string > usedVariableNameList)
	Loading test in text format More...
bool	loadFromText (System.IO.StreamReader reader, bool isCreateNewVariableName)
	Load in text format More...
override void	ChangeId (Dictionary< Guid, RomItem > inChangeIdDic)
Public Member Functions inherited from Yukar.Common.Rom.RomItem
string	getCategory (string locale=null)
	Get category path More...
	RomItem ()
	constructor More...
System.Drawing.Bitmap	getThumbnail (THUMBNAILMAKERNOTIFY notify, out bool setNotify)
	Get thumbnail image More...
System.Drawing.Bitmap	getThumbnail (THUMBNAILMAKERNOTIFY notify)
	Get thumbnail image More...
System.Drawing.Bitmap	getThumbnail ()
	Get thumbnail image More...
void	invalidateThumbnail ()
	Disable thumbnail images More...
void	invalidateThumbnail (THUMBNAILMAKERNOTIFY notify)
	Disable thumbnail images More...
void	forceInvalidateThumbnail (THUMBNAILMAKERNOTIFY notify)
	Force regeneration of thumbnail images More...
virtual void	save (BinaryWriter writer)
	keep More...
virtual void	load (BinaryReader reader)
	loading More...
virtual void	saveUsedGUID (BinaryWriter writer, bool inIncludeChildUseRomGUID)
	Export the GUID you are using (for tools) More...
void	saveUsedGUID (BinaryWriter writer)
	Export the GUID you are using (for tools) More...
virtual bool	initializingAfterLoading ()
	Initialization process after loading More...
virtual void	reImport ()
	Reimport More...
virtual void	export (string path)
	export More...
virtual void	onCatalogCleanup ()
	Catalog release processing More...
virtual void	onNameChanged ()
	Processing when renaming More...
void	copyFrom (Common.Rom.RomItem src)
	Copy data from another RomItem More...
virtual void	CheckRecourceConsistency (Catalog inCatalog)
	Consistency check (for tools) More...
virtual void	ChangeId (Dictionary< Guid, Rom.RomItem > inChangeIdDic)
	Replace the Id you are using with the corresponding Rom Id More...
void	ClearId (List< Rom.RomItem > inClearRomItemList)
	Removed rom usage in list More...
void	Dispose ()
void	AddUpdatecall (int count)
	Increase/decrease the thumbnail generation pending counter More...
void	save (BinaryWriter writer)
	keep More...
void	load (BinaryReader reader)
	loading More...

Public Attributes
Guid	templateType = Guid.Empty
	Template ID More...
string	templateInfo = ""
	Contents set in the template editor More...
Property2	property2 = new Property2()
	property 2 More...
List< Sheet >	sheetList = new List<Sheet>()
	sheet list More...
bool	valid = true
	Is this event valid? More...
bool	parentValid = true
	Is the parent event valid? More...
int	SymbolColor = 0
	event symbol color More...
int	LastOpenedSheetIndex = 0
	Previously current sheet index More...
Public Attributes inherited from Yukar.Common.Rom.RomItem
Guid	guId
	ID More...
String	name
	name More...
string	tags = ""
	tag More...
string	category = ""
	category More...

Static Public Attributes
const int	maxWalkCnt = 100
	Maximum number of steps More...
const float	maxTime = 120
	Maximum time (seconds) More...
const float	MAX_HEIGHT = 50
	Unused More...
Static Public Attributes inherited from Yukar.Common.Rom.RomItem
static int	thumbnailWidth = 128
	Thumbnail image width (pixels) More...
static int	thumbnailHeight = 128
	Thumbnail image height (pixels) More...
const char	CATEGORY_SPLITTER = '\\'
	category delimiter More...
static CREATETHUMBNAIL	createThumbnailFunction = null
	Thumbnail generation function More...
const int	UnknownRefCount = -2000
	Constants when reference count is unknown More...

Properties
Sheet	FirstSheet [get]
	first sheet More...
Guid	Graphic [get]
	Graphic ID of the event More...
string	Motion [get]
	event motion More...
string	SharpScriptPath [get, set]
	Old specifications More...
List< ScriptBinder >	SharpScripts [get]
	C# script binding information list More...
Guid	CastGuid [get, set]
	Cast event's parent cast ID (same as parent event ID) More...
Guid	ParentGuid [get, set]
	Parent ROM ID More...
RomItem	ParentRom [get]
	parent rom More...
Cast	Cast [get]
	parent cast More...
CastType	CastType [get]
	cast type More...
bool	BulletAppearFloating [get]
	Occurs while floating More...
bool	BulletIgnoreCollision [get]
	No contact with other generated events More...
bool	BulletIgnoreSameTypeCollision [get]
bool	BulletGeneratePriorty [get]
	Generate with priority More...
Guid	BulletShotSE [get]
	Generated sound More...
int	BulletMaxNum [get]
	Maximum number of occurrences (0=infinite) More...
int	BulletShotNum [get]
	Number of occurrences at one time More...
float	BulletShotInterval [get]
	firing interval More...
bool	BulletRapidFire [get]
	Allow rapid fire More...
bool	BulletNoDamage [get]
	take no damage More...
bool	UseBulletDelWalkCount [get]
	Will it disappear with the number of steps? More...
int	BulletDelWalkCount [get]
	Maximum number of steps More...
bool	UseBulletDelTime [get]
	Will it disappear with time? More...
float	BulletDelTime [get]
	Elapsed time (event extinction condition) More...
bool	BulletDelCollisionNone [get]
	Collision with “no type specified” event (event extinction condition) More...
bool	BulletDelCollisionHero [get]
	Collision with allies (event extinction condition) More...
bool	BulletDelCollisionMonster [get]
	Collision with enemy (event extinction condition) More...
bool	BulletDelCollisionMap [get]
	Collision with terrain (event extinction condition) More...
bool	BulletDelOutOfScreen [get]
	When it goes out of the screen (event disappearance condition) More...
float	InvincibleTime [get]
	Invincibility time after damage (seconds) More...
Properties inherited from Yukar.Common.Rom.RomItem
System.Drawing.Bitmap	Thumbnail [get]
	thumbnail image More...
ThumbnailStatusType	ThumbnailStatus = ThumbnailStatusType.Empty [get, set]
	Thumbnail generation status More...
string	Name [get, set]
	Get display name More...
virtual int	RefCount [get]
	reference count More...
virtual bool	UseRefCount [get]
	Should I use reference counting? More...
Folder	Parent [get, set]
	parent folder More...

Additional Inherited Members
Static Public Member Functions inherited from Yukar.Common.Rom.RomItem
static bool	reImport (List< RomItem > inRomList)
	Reimport More...
static void	writeChunk (System.IO.BinaryWriter writer, IChunk rom)
	write chunk More...
static void	readChunk (System.IO.BinaryReader reader, IChunk rom)
	load chunk More...
static void	skipChunk (System.IO.BinaryReader reader)
	skip chunk More...
static T	Clone< T > (RomItem inSrc)
	Clone RomItem More...
static bool	equalChunk (IChunk a, IChunk b)
	Are the contents of the chunks equal? More...
static IChunk	duplicate (IChunk rom)
	Duplicate IChunk More...
Protected Member Functions inherited from Yukar.Common.Rom.RomItem
virtual void	Dispose (bool disposing)

Detailed Description

Class that holds event information

Member Enumeration Documentation

MoveType

enum Yukar.Common.Rom.Event.MoveType

movement type

Enumerator
NONE
RANDOM
FOLLOW
ESCAPE

Priority

enum Yukar.Common.Rom.Event.Priority

Priority

Enumerator
UNDER
EQUAL
OVER

Constructor & Destructor Documentation

Event()

Yukar.Common.Rom.Event.Event

(

)

constructor

Member Function Documentation

addNewSheet()

void Yukar.Common.Rom.Event.addNewSheet	(	Catalog	catalog,
		string	name,
		Common.Rom.Script.Trigger	trigger = Script.Trigger.TALK
	)

add new sheet

Parameters

catalog	catalog
name	name
trigger	start trigger

ChangeId()

override void Yukar.Common.Rom.Event.ChangeId

(

Dictionary< Guid, RomItem >

inChangeIdDic

)

getSheet()

Sheet Yukar.Common.Rom.Event.getSheet

(

Guid

guid

)

Get sheet

Parameters

guid

ID

Returns

initializingAfterLoading()

override bool Yukar.Common.Rom.Event.initializingAfterLoading ( )

virtual

Initialization process after loading

Returns

Reimplemented from Yukar.Common.Rom.RomItem.

IsValid()

bool Yukar.Common.Rom.Event.IsValid

(

)

Is this event valid?

load()

override void Yukar.Common.Rom.Event.load

(

System.IO.BinaryReader

reader

)

loadFromText()

bool Yukar.Common.Rom.Event.loadFromText	(	System.IO.StreamReader	reader,
		bool	isCreateNewVariableName
	)

Load in text format

Parameters

reader	leader
isCreateNewVariableName	Create a new variable

Returns

save()

override void Yukar.Common.Rom.Event.save

(

System.IO.BinaryWriter

writer

)

saveToText()

void Yukar.Common.Rom.Event.saveToText

(

System.IO.StreamWriter

writer

)

Save as text

Parameters

writer

Writer

tryLoadFromText()

bool Yukar.Common.Rom.Event.tryLoadFromText	(	System.IO.StreamReader	reader,
		List< string >	usedVariableNameList
	)

Loading test in text format

Parameters

reader	leader
usedVariableNameList	List of variable names used

Returns

Member Data Documentation

LastOpenedSheetIndex

int Yukar.Common.Rom.Event.LastOpenedSheetIndex = 0

Previously current sheet index

MAX_HEIGHT

const float Yukar.Common.Rom.Event.MAX_HEIGHT = 50

static

Unused

maxTime

const float Yukar.Common.Rom.Event.maxTime = 120

static

Maximum time (seconds)

maxWalkCnt

const int Yukar.Common.Rom.Event.maxWalkCnt = 100

static

Maximum number of steps

parentValid

bool Yukar.Common.Rom.Event.parentValid = true

Is the parent event valid?

property2

Property2 Yukar.Common.Rom.Event.property2 = new Property2()

property 2

sheetList

List<Sheet> Yukar.Common.Rom.Event.sheetList = new List<Sheet>()

sheet list

SymbolColor

int Yukar.Common.Rom.Event.SymbolColor = 0

event symbol color

templateInfo

string Yukar.Common.Rom.Event.templateInfo = ""

Contents set in the template editor

templateType

Guid Yukar.Common.Rom.Event.templateType = Guid.Empty

Template ID

valid

bool Yukar.Common.Rom.Event.valid = true

Is this event valid?

Property Documentation

BulletAppearFloating

bool Yukar.Common.Rom.Event.BulletAppearFloating

get

Occurs while floating

BulletDelCollisionHero

bool Yukar.Common.Rom.Event.BulletDelCollisionHero

get

Collision with allies (event extinction condition)

BulletDelCollisionMap

bool Yukar.Common.Rom.Event.BulletDelCollisionMap

get

Collision with terrain (event extinction condition)

BulletDelCollisionMonster

bool Yukar.Common.Rom.Event.BulletDelCollisionMonster

get

Collision with enemy (event extinction condition)

BulletDelCollisionNone

bool Yukar.Common.Rom.Event.BulletDelCollisionNone

get

Collision with “no type specified” event (event extinction condition)

BulletDelOutOfScreen

bool Yukar.Common.Rom.Event.BulletDelOutOfScreen

get

When it goes out of the screen (event disappearance condition)

BulletDelTime

float Yukar.Common.Rom.Event.BulletDelTime

get

Elapsed time (event extinction condition)

BulletDelWalkCount

int Yukar.Common.Rom.Event.BulletDelWalkCount

get

Maximum number of steps

BulletGeneratePriorty

bool Yukar.Common.Rom.Event.BulletGeneratePriorty

get

Generate with priority

BulletIgnoreCollision

bool Yukar.Common.Rom.Event.BulletIgnoreCollision

get

No contact with other generated events

BulletIgnoreSameTypeCollision

bool Yukar.Common.Rom.Event.BulletIgnoreSameTypeCollision

get

BulletMaxNum

int Yukar.Common.Rom.Event.BulletMaxNum

get

Maximum number of occurrences (0=infinite)

BulletNoDamage

bool Yukar.Common.Rom.Event.BulletNoDamage

get

take no damage

BulletRapidFire

bool Yukar.Common.Rom.Event.BulletRapidFire

get

Allow rapid fire

BulletShotInterval

float Yukar.Common.Rom.Event.BulletShotInterval

get

firing interval

BulletShotNum

int Yukar.Common.Rom.Event.BulletShotNum

get

Number of occurrences at one time

BulletShotSE

Guid Yukar.Common.Rom.Event.BulletShotSE

get

Generated sound

Cast

Cast Yukar.Common.Rom.Event.Cast

get

parent cast

CastGuid

Guid Yukar.Common.Rom.Event.CastGuid

getset

Cast event's parent cast ID (same as parent event ID)

CastType

CastType Yukar.Common.Rom.Event.CastType

get

cast type

FirstSheet

Sheet Yukar.Common.Rom.Event.FirstSheet

get

first sheet

Graphic

Guid Yukar.Common.Rom.Event.Graphic

get

Graphic ID of the event

InvincibleTime

float Yukar.Common.Rom.Event.InvincibleTime

get

Invincibility time after damage (seconds)

Motion

string Yukar.Common.Rom.Event.Motion

get

event motion

ParentGuid

Guid Yukar.Common.Rom.Event.ParentGuid

getset

Parent ROM ID

ParentRom

RomItem Yukar.Common.Rom.Event.ParentRom

get

parent rom

SharpScriptPath

string Yukar.Common.Rom.Event.SharpScriptPath

getset

Old specifications

SharpScripts

List<ScriptBinder> Yukar.Common.Rom.Event.SharpScripts

get

C# script binding information list

UseBulletDelTime

bool Yukar.Common.Rom.Event.UseBulletDelTime

get

Will it disappear with time?

UseBulletDelWalkCount

bool Yukar.Common.Rom.Event.UseBulletDelWalkCount

get

Will it disappear with the number of steps?