3 replies to this topic

[Timelord]

I thought I'd share this here: It's a small header for checking if the screen changes, using Link->Misc[] instead of global variables, or arrays.
 
 

////////////////////////
/// ScreenChanged.zh ///
/// By: ZoriaRPG     ///
/// v0.4             ///
/// 18th Sept, 2016  ///
////////////////////////

const int LINK_MISC_SCREENCHANGES = 10;  //Link->Misc[index] that we're using to track screen changes. 

//////////////////////
/// CORE FUNCTIONS ///
//////////////////////

//Returns if the screen has changed, and we use that in the global active while loop, 
//before Waitdraw() to automate the process. 
bool ScreenChanged(){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] ) return true;
	return false;	
}

//Call before the while loop in the global active script.
//This is also called with ScreenChanged() to update the screen information. 
void UpdateScreenChanges(){
	a[0] = Game->GetCurScreen();
	a[1] = Game->GetCurDMap();
	a[2] = a[0] + ( a[1] / 10000 ); 
	Link->Misc[LINK_MISC_SCREENCHANGES] = a[2];
}

/////////////////////////
/// UTILITY FUNCTIONS ///
/////////////////////////

//! Functions to call in scripts, to perform actions based on if the screen has changed.
//! You may optionally check how it changed (scrolling, or warp), and you may optionally force an update.

//Returns if the screen has changed in general, and optionally forces an update.
bool ScreenChanged(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] ) {
		if ( update ) UpdateScreenChanges(LINK_MISC_SCREENCHANGES);
		return true;
	}
	return false;
}

//Returns if the screen changed by scrolling, and optionally forces an update.
bool ScreenScrolled(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] && Link->Action == LA_SCROLLING ) {
		if ( update ) UpdateScreenChanges(LINK_MISC_SCREENCHANGES);
		return true;
	}
	return false;
}

//Returns if the screen changed without scrolling, and optionally forces an update.
bool ScreenChangedWarp(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] && Link->Action != LA_SCROLLING ) {
		if ( update ) UpdateScreenChanges(LINK_MISC_SCREENCHANGES);
		return true;
	}
	return false;
}

//Returns if the screen changed by scrolling.
bool ScreenScrolled(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] && Link->Action == LA_SCROLLING ) return true;
	return false;
}

//Returns if the screen changed without scrolling. 
bool ScreenChangedWarp(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] && Link->Action != LA_SCROLLING ) return true;
	return false;
}

//! Example Global Active Script
global script ChangedScreen{
	void run(){
		UpdateScreenChanges(); //Initialise the values at the start of each game.
		while(true){
			if ( ScreenChanged() ) UpdateScreenChanges();
			Waitdraw();
			Waitframe();
		}
	}
}

Essentially untested, but barring typos, it should work, and I'll eventually drop it to the database.

Edited by ZoriaRPG, 18 September 2016 - 08:06 AM.

[idontknow8]

Ok, so this could be used to detect if Link came to a screen via a warp,set his Z value to high a value and then every frame, decrease it until it reaches zero? (Simulating him falling into the screen, as if falling down a hole or pit?). If so, how would I go about using this?

[Timelord]

You could.

It boccurs to me that the user may want to update after Waitdraw(), and further, that a global script isn't mandatory.b If all the user needs to check is that the screen differs from the last time it was checked, they caqn do that with an ffc.

In general, you'd just call if ( ScreenChangedWarp() ) in your code to do what you want. Pertty much, as long as you call UpdateScreenChanges(), to store the last values, you ca detect if a screen change has occurred.

I considered making flags that update one frame late, to denote how the screen last changed. That sort of thing would allow more precise detection of changes by type (scrolling, or warp). Note that scrolling side warps will return as scrolling in this case.

I'll see if I can hash out some extra content for that.

FWIW, I'd set a flag on Link->Misc[] with your warp ffc, to detect that it sent him somewhere. Tat's the best way to handle knowing the source of the change, in the example that you provided.

--------

What sorts of things would users want this to do, that it doesn't do at present?

[Timelord]

Here's where I'm leaving it off for the day...

ScreenChanged.zh v0.4.2

////////////////////////
/// ScreenChanged.zh ///
/// By: ZoriaRPG     ///
/// v0.4.2           ///
/// 19th Sept, 2016  ///
////////////////////////

//Settings

const int LAST_SCREEN_AND_DMAP_UPDATE_BEFORE_WAITDRAW = 0;
const int DO_NOT_UPDATE_DURING_SCROLLING = 0; 

const int LINK_MISC_SCREENCHANGES = 10;  //Link->Misc[index] that we're using to track screen changes. 
const int LINK_MISC_SCREENCHANGE_FLAGS = 11; //Link->Misc[index] that we're using for flags. We use the decimal side for this.
const int LINK_MISC_SCREENCHANGED_TIMER = 11;  //Link->Misc[index] that we're using for a timer.We use the integer side for this.

//Flags
const int SCREENCHANGED_WARP = 		00000001b;
const int SCREENCHANGED_SCROLLING = `	00000010b;



//////////////////////
/// CORE FUNCTIONS ///
//////////////////////

//Returns if the screen has changed, and we use that in the global active while loop, 
//before Waitdraw() to automate the process. 
bool ScreenChanged(){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] ) return true;
	return false;	
}

//Call before the while loop in the global active script.
//This is also called with ScreenChanged() to update the screen information. 
void UpdateScreenChanges(){
	a[0] = Game->GetCurScreen();
	a[1] = Game->GetCurDMap();
	a[2] = a[0] + ( a[1] / 10000 ); 
	Link->Misc[LINK_MISC_SCREENCHANGES] = a[2];
}

/////////////////////////
/// UTILITY FUNCTIONS ///
/////////////////////////

//! Functions to call in scripts, to perform actions based on if the screen has changed.
//! You may optionally check how it changed (scrolling, or warp), and you may optionally force an update.

//Returns the last stored CurScreen()
int GetLastScreen(){
	return Link->Misc[LINK_MISC_SCREENCHANGES] << 0;
}

//Returns the last stored CurDMap()
int GetLastDMap(){
	return ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000;
}

//Returns if the screen has changed in general, and optionally forces an update.
bool ScreenChanged(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] ) {
		if ( update ) UpdateScreenChanges(LINK_MISC_SCREENCHANGES);
		return true;
	}
	return false;
}

//Returns if the screen changed by scrolling, and optionally forces an update.
bool ScreenScrolled(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] && Link->Action == LA_SCROLLING ) {
		if ( update ) UpdateScreenChanges(LINK_MISC_SCREENCHANGES);
		return true;
	}
	return false;
}

//Returns if the screen changed without scrolling, and optionally forces an update.
bool ScreenChangedWarp(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] && Link->Action != LA_SCROLLING ) {
		if ( update ) UpdateScreenChanges(LINK_MISC_SCREENCHANGES);
		return true;
	}
	return false;
}

//Returns if the screen changed by scrolling.
bool ScreenScrolled(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] && Link->Action == LA_SCROLLING ) return true;
	return false;
}

//Returns if the screen changed without scrolling. 
bool ScreenChangedWarp(bool update){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGES] << 0; //CurScreen
	a[1] = ( Link->Misc[LINK_MISC_SCREENCHANGES] - ( Link->Misc[LINK_MISC_SCREENCHANGES] << 0 ) ) *10000; //CurDMap
	if ( Game->GetCurScreen() != a[0] && Game->GetCurDMap() != a[1] && Link->Action != LA_SCROLLING ) return true;
	return false;
}

//////////////////////////////////////
/// Functions for Flags and Timers ///
//////////////////////////////////////

//Check if a screen change flag was set.
bool ScreenChageFlag(int flag){
	return ( ( ( Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS] << 0 - ( Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS] << 0 >> 0)) * 10000 )&flag ) != 0;
}

//Sets a screen change flag.
void ScreenChangeFlag(int flag, bool state){
	int val[3];
	val[0]= Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS];
	val[1]= val[0] << 0; //Integer side
	val[2] = val[0] - val[1]; //Decimal side.
	if ( state ) val[2] |= flag;
	else val[2] &= ~flag;
	Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS] = val[1]+val[2]; //Preserve the decimal, and replace the integer.
}

//Call to reduce the timer by 1.
void ReduceScreenChangeTimer(){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS];
	a[1]= a[0] << 0; //Integer side
	a[2] = a[0] - a[1]; //Decimal side.
	if ( a[1] > 0 ) a[1]--; //Reduce it.
	Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS] = a[1] + a[2];
}

//Set the initial timer duration to 'time'.
int SetScreenChangeTimer(int time){
	int a[3];
	a[0] = Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS];
	a[1]= a[0] << 0; //Integer side
	a[2] = a[0] - a[1]; //Decimal side.
	a[1] = time; //Set it.
	Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS] = a[1] + a[2];
}

//Returns the present timer value. 
int GetScreenChangeTimer(int time){
	return Link->Misc[LINK_MISC_SCREENCHANGE_FLAGS] << 0;
}

//! Example Global Active Script
global script ChangedScreen{
	void run(){
		UpdateScreenChanges(); //Initialise the values at the start of each game.
		while(true){
			if ( LAST_SCREEN_AND_DMAP_UPDATE_BEFORE_WAITDRAW && ScreenChanged() && ( ( DO_NOT_UPDATE_DURING_SCROLLING && Link->Action != LA_SCROLLING ) || !DO_NOT_UPDATE_DURING_SCROLLING )  ) UpdateScreenChanges();
			Waitdraw();
			if ( !LAST_SCREEN_AND_DMAP_UPDATE_BEFORE_WAITDRAW && ScreenChanged() && ( ( DO_NOT_UPDATE_DURING_SCROLLING && Link->Action != LA_SCROLLING ) || !DO_NOT_UPDATE_DURING_SCROLLING ) ) UpdateScreenChanges();
			Waitframe();
		}
	}
}

const int SCREEN_CHANGE_FLAG_WAIT_TIME = 5; //Frames to wait before clearing a screen change type flag.
void MarkScreenChangeType(){
	
	//Set up a routine to wait X frames before clearing the screen changed flag.
	
	// if ( SCREENCHANGTE_WAIT_A_FEW_FRAMES ) {
		//if we have yet to set the timer...
		if ( GetScreenChangeTimer() == SCREEN_CHANGE_TIMER_OFF ) 
			//Set it to our desired duration. 
			SetScreenChangeTimer(SCREEN_CHANGE_FLAG_WAIT_TIME);
	//&& GetScreenChangeTimer() ) 
	
}

void DoScreenChangeTimer(){
	if ( GetScreenChangeTimer() && GetScreenChangeTimer() != SCREEN_CHANGE_TIMER_OFF ) {
		ReduceScreenChangeTimer();
		//If the timer reaches zero, we need to clear it, and do other things.
	}
}
	
void InitScreenChangeTimer() { SetScreenChangeTimer(SCREEN_CHANGE_TIMER_OFF); } //So that we know it is primed. We also do this when we set the timer during fucntion calls, to distinguish from zero.
const int SCREEN_CHANGE_TIMER_OFF = 9999;

Edited by ZoriaRPG, 19 September 2016 - 10:07 AM.