nwnx_area.nss

Go to the documentation of this file.

 
const string NWNX_Area = "NWNX_Area"; 
 
const int NWNX_AREA_PVP_SETTING_NO_PVP              = 0;
const int NWNX_AREA_PVP_SETTING_PARTY_PVP           = 1;
const int NWNX_AREA_PVP_SETTING_FULL_PVP            = 2;
const int NWNX_AREA_PVP_SETTING_SERVER_DEFAULT      = 3;
 
const int NWNX_AREA_WEATHER_CHANCE_RAIN             = 0;
const int NWNX_AREA_WEATHER_CHANCE_SNOW             = 1;
const int NWNX_AREA_WEATHER_CHANCE_LIGHTNING        = 2;
 
const int NWNX_AREA_DAYNIGHTCYCLE_CYCLE_DAY_NIGHT   = 0;
const int NWNX_AREA_DAYNIGHTCYCLE_ALWAYS_BRIGHT     = 1;
const int NWNX_AREA_DAYNIGHTCYCLE_ALWAYS_DARK       = 2;
 
const int NWNX_AREA_COLOR_TYPE_MOON_AMBIENT         = 0;
const int NWNX_AREA_COLOR_TYPE_MOON_DIFFUSE         = 1;
const int NWNX_AREA_COLOR_TYPE_SUN_AMBIENT          = 2;
const int NWNX_AREA_COLOR_TYPE_SUN_DIFFUSE          = 3;
 
struct NWNX_Area_TileInfo
{
    int nID; 
    int nHeight; 
    int nOrientation; 
    int nGridX; 
    int nGridY; 
};
 
struct NWNX_Area_AreaWind
{
    vector vDirection; 
    float fMagnitude; 
    float fYaw; 
    float fPitch; 
};
 
int NWNX_Area_GetNumberOfPlayersInArea(object area);
 
object NWNX_Area_GetLastEntered(object area);
 
object NWNX_Area_GetLastLeft(object area);
 
int NWNX_Area_GetPVPSetting(object area);
 
void NWNX_Area_SetPVPSetting(object area, int pvpSetting);
 
int NWNX_Area_GetAreaSpotModifier(object area);
 
void NWNX_Area_SetAreaSpotModifier(object area, int spotModifier);
 
int NWNX_Area_GetAreaListenModifier(object area);
 
void NWNX_Area_SetAreaListenModifier(object area, int listenModifier);
 
int NWNX_Area_GetNoRestingAllowed(object area);
 
void NWNX_Area_SetNoRestingAllowed(object area, int bNoRestingAllowed);
 
int NWNX_Area_GetWindPower(object area);
 
void NWNX_Area_SetWindPower(object area, int windPower);
 
int NWNX_Area_GetWeatherChance(object area, int type);
 
void NWNX_Area_SetWeatherChance(object area, int type, int chance);
 
float NWNX_Area_GetFogClipDistance(object area);
 
void NWNX_Area_SetFogClipDistance(object area, float distance);
 
int NWNX_Area_GetShadowOpacity(object area);
 
void NWNX_Area_SetShadowOpacity(object area, int shadowOpacity);
 
int NWNX_Area_GetDayNightCycle(object area);
 
void NWNX_Area_SetDayNightCycle(object area, int type);
 
int NWNX_Area_GetSunMoonColors(object area, int type);
 
// type = NWNX_AREA_COLOR_TYPE_*
void NWNX_Area_SetSunMoonColors(object area, int type, int color);
 
object NWNX_Area_CreateTransition(object area, object target, float x, float y, float z, float size = 2.0f, string tag="");
 
int NWNX_Area_GetTileAnimationLoop(object oArea, float fTileX, float fTileY, int nAnimLoop);
 
void NWNX_Area_SetTileAnimationLoop(object oArea, float fTileX, float fTileY, int nAnimLoop, int bEnabled);
 
string NWNX_Area_GetTileModelResRef(object oArea, float fTileX, float fTileY);
 
int NWNX_Area_TestDirectLine(object oArea, float fStartX, float fStartY, float fEndX, float fEndY, float fPerSpace, float fHeight, int bIgnoreDoors=FALSE);
 
int NWNX_Area_GetMusicIsPlaying(object oArea, int bBattleMusic = FALSE);
 
object NWNX_Area_CreateGenericTrigger(object oArea, float fX, float fY, float fZ, string sTag = "", float fSize = 1.0f);
 
void NWNX_Area_AddObjectToExclusionList(object oObject);
 
void NWNX_Area_RemoveObjectFromExclusionList(object oObject);
 
int NWNX_Area_ExportGIT(object oArea, string sFileName = "", int bExportVarTable = TRUE, int bExportUUID = TRUE, int nObjectFilter = 0, string sAlias = "NWNX");
 
struct NWNX_Area_TileInfo NWNX_Area_GetTileInfo(object oArea, float fTileX, float fTileY);
 
int NWNX_Area_ExportARE(object oArea, string sFileName, string sNewName = "", string sNewTag = "", string sAlias = "NWNX");
 
int NWNX_Area_GetAmbientSoundDay(object oArea);
 
int NWNX_Area_GetAmbientSoundNight(object oArea);
 
int NWNX_Area_GetAmbientSoundDayVolume(object oArea);
 
int NWNX_Area_GetAmbientSoundNightVolume(object oArea);
 
object NWNX_Area_CreateSoundObject(object oArea, vector vPosition, string sResRef);
 
void NWNX_Area_RotateArea(object oArea, int nRotation);
 
struct NWNX_Area_TileInfo NWNX_Area_GetTileInfoByTileIndex(object oArea, int nIndex);
 
int NWNX_Area_GetPathExists(object oArea, vector vStartPosition, vector vEndPosition, int nMaxDepth);
 
int NWNX_Area_GetAreaFlags(object oArea);
 
void NWNX_Area_SetAreaFlags(object oArea, int nFlags);
 
struct NWNX_Area_AreaWind NWNX_Area_GetAreaWind(object oArea);
 
void NWNX_Area_SetDefaultObjectUiDiscoveryMask(object oArea, int nObjectTypes, int nMask, int bForceUpdate = FALSE);
 
 
int NWNX_Area_GetNumberOfPlayersInArea(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetNumberOfPlayersInArea");
    return NWNXPopInt();
}
 
object NWNX_Area_GetLastEntered(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetLastEntered");
    return NWNXPopObject();
}
 
object NWNX_Area_GetLastLeft(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetLastLeft");
    return NWNXPopObject();
}
 
int NWNX_Area_GetPVPSetting(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetPVPSetting");
    return NWNXPopInt();
}
 
void NWNX_Area_SetPVPSetting(object area, int pvpSetting)
{
    NWNXPushInt(pvpSetting);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetPVPSetting");
}
 
int NWNX_Area_GetAreaSpotModifier(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetAreaSpotModifier");
    return NWNXPopInt();
}
 
void NWNX_Area_SetAreaSpotModifier(object area, int spotModifier)
{
    NWNXPushInt(spotModifier);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetAreaSpotModifier");
}
 
int NWNX_Area_GetAreaListenModifier(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetAreaListenModifier");
    return NWNXPopInt();
}
 
void NWNX_Area_SetAreaListenModifier(object area, int listenModifier)
{
    NWNXPushInt(listenModifier);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetAreaListenModifier");
}
 
int NWNX_Area_GetNoRestingAllowed(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetNoRestingAllowed");
    return NWNXPopInt();
}
 
void NWNX_Area_SetNoRestingAllowed(object area, int bNoRestingAllowed)
{
    NWNXPushInt(bNoRestingAllowed);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetNoRestingAllowed");
}
 
int NWNX_Area_GetWindPower(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetWindPower");
    return NWNXPopInt();
}
 
void NWNX_Area_SetWindPower(object area, int windPower)
{
    NWNXPushInt(windPower);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetWindPower");
}
 
int NWNX_Area_GetWeatherChance(object area, int type)
{
    NWNXPushInt(type);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetWeatherChance");
    return NWNXPopInt();
}
 
void NWNX_Area_SetWeatherChance(object area, int type, int chance)
{
    NWNXPushInt(chance);
    NWNXPushInt(type);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetWeatherChance");
}
 
float NWNX_Area_GetFogClipDistance(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetFogClipDistance");
    return NWNXPopFloat();
}
 
void NWNX_Area_SetFogClipDistance(object area, float distance)
{
    NWNXPushFloat(distance);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetFogClipDistance");
}
 
int NWNX_Area_GetShadowOpacity(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetShadowOpacity");
    return NWNXPopInt();
}
 
void NWNX_Area_SetShadowOpacity(object area, int shadowOpacity)
{
    NWNXPushInt(shadowOpacity);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetShadowOpacity");
}
 
 
int NWNX_Area_GetDayNightCycle(object area)
{
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetDayNightCycle");
    return NWNXPopInt();
}
 
void NWNX_Area_SetDayNightCycle(object area, int type)
{
    NWNXPushInt(type);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetDayNightCycle");
}
 
int NWNX_Area_GetSunMoonColors(object area, int type)
{
    NWNXPushInt(type);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "GetSunMoonColors");
    return NWNXPopInt();
}
 
void NWNX_Area_SetSunMoonColors(object area, int type, int color)
{
    NWNXPushInt(color);
    NWNXPushInt(type);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "SetSunMoonColors");
}
 
object NWNX_Area_CreateTransition(object area, object target, float x, float y, float z, float size = 2.0f, string tag="")
{
    NWNXPushString(tag);
    NWNXPushFloat(size);
    NWNXPushFloat(z);
    NWNXPushFloat(y);
    NWNXPushFloat(x);
    NWNXPushObject(target);
    NWNXPushObject(area);
    NWNXCall(NWNX_Area, "CreateTransition");
    return NWNXPopObject();
}
 
int NWNX_Area_GetTileAnimationLoop(object oArea, float fTileX, float fTileY, int nAnimLoop)
{
    NWNXPushInt(nAnimLoop);
    NWNXPushFloat(fTileY);
    NWNXPushFloat(fTileX);
    NWNXPushObject(oArea);
 
    NWNXCall(NWNX_Area, "GetTileAnimationLoop");
    return NWNXPopInt();
}
 
void NWNX_Area_SetTileAnimationLoop(object oArea, float fTileX, float fTileY, int nAnimLoop, int bEnabled)
{
    NWNXPushInt(bEnabled);
    NWNXPushInt(nAnimLoop);
    NWNXPushFloat(fTileY);
    NWNXPushFloat(fTileX);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "SetTileAnimationLoop");
}
 
string NWNX_Area_GetTileModelResRef(object oArea, float fTileX, float fTileY)
{
    NWNXPushFloat(fTileY);
    NWNXPushFloat(fTileX);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetTileModelResRef");
    return NWNXPopString();
}
 
int NWNX_Area_TestDirectLine(object oArea, float fStartX, float fStartY, float fEndX, float fEndY, float fPerSpace, float fHeight, int bIgnoreDoors=FALSE)
{
    NWNXPushInt(bIgnoreDoors);
    NWNXPushFloat(fHeight);
    NWNXPushFloat(fPerSpace);
    NWNXPushFloat(fEndY);
    NWNXPushFloat(fEndX);
    NWNXPushFloat(fStartY);
    NWNXPushFloat(fStartX);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "TestDirectLine");
    return NWNXPopInt();
}
 
int NWNX_Area_GetMusicIsPlaying(object oArea, int bBattleMusic = FALSE)
{
    NWNXPushInt(bBattleMusic);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetMusicIsPlaying");
    return NWNXPopInt();
}
 
object NWNX_Area_CreateGenericTrigger(object oArea, float fX, float fY, float fZ, string sTag = "", float fSize = 1.0f)
{
    NWNXPushFloat(fSize);
    NWNXPushString(sTag);
    NWNXPushFloat(fZ);
    NWNXPushFloat(fY);
    NWNXPushFloat(fX);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "CreateGenericTrigger");
    return NWNXPopObject();
}
 
void NWNX_Area_AddObjectToExclusionList(object oObject)
{
    NWNXPushObject(oObject);
    NWNXCall(NWNX_Area, "AddObjectToExclusionList");
}
 
void NWNX_Area_RemoveObjectFromExclusionList(object oObject)
{
    NWNXPushObject(oObject);
    NWNXCall(NWNX_Area, "RemoveObjectFromExclusionList");
}
 
int NWNX_Area_ExportGIT(object oArea, string sFileName = "", int bExportVarTable = TRUE, int bExportUUID = TRUE, int nObjectFilter = 0, string sAlias = "NWNX")
{
    NWNXPushString(sAlias);
    NWNXPushInt(nObjectFilter);
    NWNXPushInt(bExportUUID);
    NWNXPushInt(bExportVarTable);
    NWNXPushString(sFileName);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "ExportGIT");
    return NWNXPopInt();
}
 
struct NWNX_Area_TileInfo NWNX_Area_GetTileInfo(object oArea, float fTileX, float fTileY)
{
    NWNXPushFloat(fTileY);
    NWNXPushFloat(fTileX);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetTileInfo");
    struct NWNX_Area_TileInfo str;
    str.nGridY = NWNXPopInt();
    str.nGridX = NWNXPopInt();
    str.nOrientation = NWNXPopInt();
    str.nHeight = NWNXPopInt();
    str.nID = NWNXPopInt();
    return str;
}
 
int NWNX_Area_ExportARE(object oArea, string sFileName, string sNewName = "", string sNewTag = "", string sAlias = "NWNX")
{
    NWNXPushString(sAlias);
    NWNXPushString(sNewTag);
    NWNXPushString(sNewName);
    NWNXPushString(sFileName);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "ExportARE");
    return NWNXPopInt();
}
 
int NWNX_Area_GetAmbientSoundDay(object oArea)
{
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetAmbientSoundDay");
    return NWNXPopInt();
}
 
int NWNX_Area_GetAmbientSoundNight(object oArea)
{
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetAmbientSoundNight");
    return NWNXPopInt();
}
 
int NWNX_Area_GetAmbientSoundDayVolume(object oArea)
{
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetAmbientSoundDayVolume");
    return NWNXPopInt();
}
 
int NWNX_Area_GetAmbientSoundNightVolume(object oArea)
{
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetAmbientSoundNightVolume");
    return NWNXPopInt();
}
 
object NWNX_Area_CreateSoundObject(object oArea, vector vPosition, string sResRef)
{
    NWNXPushString(sResRef);
    NWNXPushVector(vPosition);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "CreateSoundObject");
    return NWNXPopObject();
}
 
void NWNX_Area_RotateArea(object oArea, int nRotation)
{
    NWNXPushInt(nRotation);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "RotateArea");
}
 
struct NWNX_Area_TileInfo NWNX_Area_GetTileInfoByTileIndex(object oArea, int nIndex)
{
    NWNXPushInt(nIndex);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetTileInfoByTileIndex");
    struct NWNX_Area_TileInfo str;
    str.nGridY = NWNXPopInt();
    str.nGridX = NWNXPopInt();
    str.nOrientation = NWNXPopInt();
    str.nHeight = NWNXPopInt();
    str.nID = NWNXPopInt();
    return str;
}
 
int NWNX_Area_GetPathExists(object oArea, vector vStartPosition, vector vEndPosition, int nMaxDepth)
{
    NWNXPushInt(nMaxDepth);
    NWNXPushVector(vEndPosition);
    NWNXPushVector(vStartPosition);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetPathExists");
    return NWNXPopInt();
}
 
int NWNX_Area_GetAreaFlags(object oArea)
{
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetAreaFlags");
    return NWNXPopInt();
}
 
void NWNX_Area_SetAreaFlags(object oArea, int nFlags)
{
    NWNXPushInt(nFlags);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "SetAreaFlags");
}
 
struct NWNX_Area_AreaWind NWNX_Area_GetAreaWind(object oArea)
{
    struct NWNX_Area_AreaWind data;
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "GetAreaWind");
    data.fPitch = NWNXPopFloat();
    data.fYaw = NWNXPopFloat();
    data.fMagnitude = NWNXPopFloat();
    data.vDirection = NWNXPopVector();
    return data;
}
 
void NWNX_Area_SetDefaultObjectUiDiscoveryMask(object oArea, int nObjectTypes, int nMask, int bForceUpdate = FALSE)
{
    NWNXPushInt(bForceUpdate);
    NWNXPushInt(nMask);
    NWNXPushInt(nObjectTypes);
    NWNXPushObject(oArea);
    NWNXCall(NWNX_Area, "SetDefaultObjectUiDiscoveryMask");
}