Skins: |

NWN2 SCRIPTS

- Jump to comments -

Name

Simple Day Night Cycle Lighting System

Author

Vanes

Submitted / Updated

03-03-2011 / 03-04-2011

Category

Entire Module/PW systems

Type

Type - Lighting

Format

Module and Code

ShowCode

/*---------------------------------
  --   DayNight Cycle Lighting   --
  ---------------------------------
		
  Created By: Vanes from irc.nwn2source.net #NWN2CR

  Usage: 
  
  1.  Include this script anywhere, most preferably to an area event script and call it whenever you want by using
      DoAreaDayNightLighting(oArea); where oArea is the Area Object.
	  It will change the lighting for a single area. It will only change anything once for each cycle on an area.
		 
  2.  Place waypoints with the tag specified below (DAYNIGHT_LIGHT_WP) where-ever you want in the area.
  
  3a. Create lights as blueprints for all the cycles and edit the waypoints to have variables named:
      DAWN,DAY,DUSK,MOONRISE,NIGHT,MOONSET (as defined below) to point to the resrefs of these lights.
	 
	  Example: variable named "Sunrise" with value "mylight1", "Moonrise" with value "mylight7"
	 
  3b. Instead of doing that, just use a naming convention for your light resrefs where you have
      sets of lights with "_" + DAWN/DAY/DUSK/MOONRISE/NIGHT/MOONSET appended to them.
	 
	  Example: "mylight_sunrise", "mylight_daytime", "mylight_sunset" etc.
	 
	  To use these lights instead of the ones in the variables, you must have the variable "USE_NEAR_LIGHT" = 1
	  on the waypoints and have one of these lights near the waypoint (within 2m). 
	  		 		
  4.  It should work now. Have fun! :)
	  
*/





//Configuration:

//Debug on/off
const int DEBUG_DAYNIGHTLIGHTS = FALSE;

//The object with this tag holds the information about the lights
//If not valid, will use the area instead.
//Only place one of these objects in the module.
const string LIGHT_MANAGER = "LIGHT_MANAGER";

//This is the tag used for all the waypoints that need lights that change
//depending on the DayNight Cycle.
const string DAYNIGHT_LIGHT_WP = "wp_daynight_light";

const string DAWN = "Sunrise";
const string DAY = "Daytime";
const string DUSK = "Sunset";
const string MOONRISE = "Moonrise";
const string NIGHT = "Nighttime";
const string MOONSET = "Moonset";

//This is the height of lights compared to the WPs. Not used if USE_NEAR_LIGHT = 1
const float LIGHT_DEFAULT_HEIGHT = 2.5f;

//This is the distance that lights can be from the WPs if USE_NEAR_LIGHT = 1
const float LIGHT_DEFAULT_DISTANCE = 2.5f;


//Methods:

//This returns the current DayNight Cycle as a string
string GetCurrentDayNightCycle();
//This replaces just one light at a waypoint with its proper counter-part for the cycle.
void ReplaceLight(object oWP, string sCycle);
//This replaced all the Lights in the area that have a specific tag to their right counter-parts for
//the current DayNight Cycle.
void ReplaceDayNightLightObjects(object oArea, string sCycle);
//Just basic debug info
void DebugS(string s);
//This only investigates if the object is too far to the X/Y directions
int GetIsNear(object o1, object o2);





//This is the main script
void DoAreaDayNightLighting(object oArea)
{
object oLightManager = GetObjectByTag(LIGHT_MANAGER);
if (oLightManager==OBJECT_INVALID) oLightManager = oArea;

string sLastCycle = GetLocalString(oLightManager,"LCYCLE_" + GetResRef(oArea));
string sCurCycle = GetCurrentDayNightCycle();

DebugS("Current Cycle: "+sCurCycle + ", Previous Cycle: "+sLastCycle);

//The cycle hasn't changed..so don't do anything
if (sCurCycle == sLastCycle) return;

//This does all the heavy lifting
ReplaceDayNightLightObjects(oArea,sCurCycle);

SetLocalString(oLightManager,"LCYCLE_" + GetResRef(oArea),sCurCycle);
}





//This returns the current DayNight Cycle as a string
string GetCurrentDayNightCycle()
{
string sCycle;
int iHour = GetTimeHour();
//Dawn == Sunrise == 6
int iDawn = GetIsDawn();
if (iDawn) sCycle = DAWN;
//Day == 7-17
int iDay = GetIsDay();
if (iDay) sCycle = DAY;
//Dusk == Sunset == 18
int iDusk = GetIsDusk();
if (iDusk) sCycle = DUSK;
//Moonrise == 19
int iMoonRise = (iHour==19);
if (iMoonRise) sCycle = MOONRISE;
//Night == 20-4
int iNight = GetIsNight();
if (iNight && !iMoonRise) sCycle = NIGHT;
//Moonset == 5
int iMoonSet = (iHour==5);
if (iMoonSet) sCycle = MOONSET;
return sCycle;
}

void DebugS(string s)
{
if (DEBUG_DAYNIGHTLIGHTS) AssignCommand(GetModule(),SpeakString(s,TALKVOLUME_SHOUT));
}

//This only investigates if the object is too far to the X/Y directions
int GetIsNear(object o1, object o2)
{
vector v1 = GetPosition(o1);
vector v2 = GetPosition(o2);

if (fabs(v1.x - v2.x) + fabs(v1.y - v2.y) <= LIGHT_DEFAULT_DISTANCE) return TRUE;
return FALSE;
}

//This replaces just one light at a waypoint with its proper counter-part for the cycle.
void ReplaceLight(object oWP, string sCycle)
{
string sResref;
int iUseNearLight = GetLocalInt(oWP,"USE_NEAR_LIGHT");
object oLight = GetNearestObject(OBJECT_TYPE_LIGHT,oWP,1);
if (oLight!=OBJECT_INVALID && !GetIsNear(oLight,oWP)) oLight = OBJECT_INVALID;
location lLoc;

if (iUseNearLight && oLight!=OBJECT_INVALID)
	{	
	sResref = GetResRef(oLight);
	int iFind = FindSubString(sResref,"_") + 1;		
	if (iFind!=0)
		{
		sResref = GetSubString(sResref,0,iFind) + GetStringLowerCase(sCycle);
		}
	lLoc = GetLocation(oLight);	
	
	vector vPos = GetPositionFromLocation(lLoc);
	DebugS("Using nearest light. sResref = "+sResref);
	}
else
	{
	sResref = GetLocalString(oWP,sCycle);
	if (sResref == "") 
		{
		DebugS("No variable specified and not using Nearest Light. Aborting.");
		return;
		}
	lLoc = Location(GetArea(oWP),GetPosition(oWP) + Vector(0.0f,0.0f,LIGHT_DEFAULT_HEIGHT),0.0f);
	vector vPos = GetPositionFromLocation(lLoc);	
	DebugS("Using resref from variable. sResref = "+sResref);
	}		

if (oLight != OBJECT_INVALID)
	{
	DestroyObject(oLight);	
	}
	
CreateObject(OBJECT_TYPE_LIGHT,sResref,lLoc);
}

//This replaced all the Lights in the area that have a specific tag to their right counter-parts for
//the current DayNight Cycle.
void ReplaceDayNightLightObjects(object oArea, string sCycle)
{
object oStart = GetFirstObjectInArea(oArea);
object oWP;
string sTag = GetTag(oStart);
int i = 1;
int n = 0;
if (sTag == DAYNIGHT_LIGHT_WP) 
	{
	ReplaceLight(oStart,sCycle);
	n += 1;
	}
oWP = GetNearestObjectByTag(DAYNIGHT_LIGHT_WP,oStart,1);

while(oWP!=OBJECT_INVALID)
	{
	ReplaceLight(oWP,sCycle);
	i += 1;
	n += 1;
	oWP = GetNearestObjectByTag(DAYNIGHT_LIGHT_WP,oStart,i);
	}
	
DebugS("Replaced "+IntToString(n)+" daynight light objects");	
}

Select All Text | View Code in separate window

Patch

1.23

NWN2Game

All

Description

This is something I thought people could use. It's simply enough a system that handles lighting in a module. It will change the lighting based on the current DayNight Cycle.

The script itself has all the instructions needed in 3 simple steps.

But here's an example setup that works without downloading the erf and using the files there. If you download the erf, you have the lights/waypoints created for you. They use a naming convention so you can have multiple different sets of lights. Also you can fully specify the different daynight lights by using variables in the waypoints instead.

1. Create waypoints in your templates with tag "wp_daynight_light"
2. Edit the waypoint to have the variable "USE_NEAR_LIGHT" set to 1.
3. Create lights to your templates with the following resrefs:

mylight_sunrise
mylight_daytime
mylight_sunset
mylight_moonrise
mylight_nighttime
mylight_moonset

4. Place the waypoint we made earlier in any place you're going to need lights that change states with cycles.

5. Place any one of those lights right next to all the waypoints. It can be as high as you want, but must not be too far from the waypoint in X/Y directions.

6. Create a waypoint with tag "LIGHT_MANAGER" anywhere in your area. Only one of these per module.

7. Play! :)

Files

Name	Type	Size	Downloads
DayNightLight.modDayNightLight.mod Submitted: 03-03-2011 / Last Updated: 03-03-2011	mod	434.52Kb	28
Example Module.
DayNightLights.erfDayNightLights.erf Submitted: 03-03-2011 / Last Updated: 03-03-2011	erf	18.04Kb	30
Include this in your module.

SCORE OUT OF 10

10
1 votes
View Stats
Cast Your Vote!
Voting FAQ

PORTFOLIO

Add this entry to your portfolio so you can track it

Manage your existing portfolios or create a new one.

SCREENS

No Images

You Must Be Logged In to Participate.

Comments (3):

Posted by Vanes at 2011-03-07 21:18:25

Yeah you could do that. Though I don't think there's much to gain in performance in any case. We're only dealing with a couple lights per area, and it's only doing something every 10 minutes or so on average, in the few interior areas people might be at any one time. But you're right, "caching" the light objects would be more efficient.
_________________________
Logical arguments tend to favour those who have much faith vested in them. Often accompanied by an epic skill to resist the arguments against.

Posted by DannJ at 2011-03-06 13:56:11

Why destroy the light objects? Why not just activate and deactivate them as necessary?

Posted by Banshe at 2011-03-05 11:58:39 Voted 10.00 on 03/05/11

Cool!

You must be Logged In to post comments in this section.

NWN2 Voting Standards

10 - A Masterpiece, Genuinely Groundbreaking
9 - Outstanding, a Must Have
8 - Excellent, Recommended to Anyone
7 - Very Good, Deserves a Look
6 - Good, Qualified Recommendation
5 - Fair, Solid yet Unremarkable
4 - Some Merit, Requires Improvements
3 - Poor Execution, Potential Unrealized
2 - Very Little Appeal
1 - Not Recommended to Anyone