Planeshift
psOptions Class Reference

#include <psoptions.h>

Public Member Functions

double CalcFunction (MathEnvironment *env, const char *functionName, const double *params)
 
const char * GetOption (const char *className, const char *name, const char *defaultValue)
 Gets the value of a specific option. More...
 
float GetOption (const char *className, const char *name, float defaultValue)
 
int GetOption (const char *className, const char *name, int defaultValue)
 
bool GetOption (const char *className, const char *name, bool defaultValue)
 
double GetProperty (MathEnvironment *env, const char *ptr)
 
void Load ()
 This will load/reload all options. More...
 
void NewSubscription (const char *name)
 
void OnUpdateData (const char *name, PAWSData &data)
 
 psOptions (const char *filename, iVFS *vfs)
 
void RegisterOptionsClass (const char *className, iOptionsClass *optionsClass)
 Registers a new options class with the options system. More...
 
void Save ()
 Save will apply the values of all current options to the options classes. More...
 
void SetOption (const char *className, const char *name, const char *value)
 Sets the value of a specific option. More...
 
void SetOption (const char *className, const char *name, float value)
 
void SetOption (const char *className, const char *name, int value)
 
void SetOption (const char *className, const char *name, bool value)
 
const char * ToString ()
 
 ~psOptions ()
 
- Public Member Functions inherited from iPAWSSubscriber
virtual ~iPAWSSubscriber ()
 
- Public Member Functions inherited from iScriptableVar
virtual ~iScriptableVar ()
 

Detailed Description

Definition at line 51 of file psoptions.h.

Constructor & Destructor Documentation

psOptions::psOptions ( const char *  filename,
iVFS *  vfs 
)
psOptions::~psOptions ( )

Member Function Documentation

double psOptions::CalcFunction ( MathEnvironment env,
const char *  functionName,
const double *  params 
)
virtual

Implements iScriptableVar.

const char* psOptions::GetOption ( const char *  className,
const char *  name,
const char *  defaultValue 
)

Gets the value of a specific option.

float psOptions::GetOption ( const char *  className,
const char *  name,
float  defaultValue 
)
int psOptions::GetOption ( const char *  className,
const char *  name,
int  defaultValue 
)
bool psOptions::GetOption ( const char *  className,
const char *  name,
bool  defaultValue 
)
double psOptions::GetProperty ( MathEnvironment env,
const char *  ptr 
)
virtual

Implements iScriptableVar.

void psOptions::Load ( )

This will load/reload all options.

void psOptions::NewSubscription ( const char *  name)
virtual

Implements iPAWSSubscriber.

void psOptions::OnUpdateData ( const char *  name,
PAWSData data 
)
virtual

Implements iPAWSSubscriber.

void psOptions::RegisterOptionsClass ( const char *  className,
iOptionsClass optionsClass 
)

Registers a new options class with the options system.

void psOptions::Save ( )

Save will apply the values of all current options to the options classes.

void psOptions::SetOption ( const char *  className,
const char *  name,
const char *  value 
)

Sets the value of a specific option.

void psOptions::SetOption ( const char *  className,
const char *  name,
float  value 
)
void psOptions::SetOption ( const char *  className,
const char *  name,
int  value 
)
void psOptions::SetOption ( const char *  className,
const char *  name,
bool  value 
)
const char* psOptions::ToString ( )
inlinevirtual

Implements iScriptableVar.

Definition at line 73 of file psoptions.h.


The documentation for this class was generated from the following file: