Main   GitHub

Methods | List of all members
NetObject Class Reference

Inherits SimObject, and SimObject.

Inherited by SimpleNetObject, and SimpleNetObject.

Methods

void clearScopeToClient (client)
 
void clearScopeToClient (client)
 
int getGhostID ()
 
int getGhostID ()
 
void scopeToClient (client)
 
void scopeToClient (client)
 
void setScopeAlways ()
 
void setScopeAlways ()
 
- Methods inherited from SimObject
void addFieldFilter (fieldName)
 
void addFieldFilter (fieldName)
 
string call (%args)
 
string call (%args)
 
int clone ([bool copyDynamicFields?=false])
 
int clone ([bool copyDynamicFields?=false])
 
void delete ()
 
void delete ()
 
void dump ()
 
void dump ()
 
void dumpClassHierarchy ()
 
void dumpClassHierarchy ()
 
string getClassName ()
 
string getClassName ()
 
string getClassNamespace ()
 
string getClassNamespace ()
 
string getDynamicField (index)
 
string getDynamicField (index)
 
int getDynamicFieldCount ()
 
int getDynamicFieldCount ()
 
string getField (int index)
 
string getField (int index)
 
int getFieldCount ()
 
int getFieldCount ()
 
string getFieldType (fieldName)
 
string getFieldType (fieldName)
 
string getFieldValue (fieldName)
 
string getFieldValue (fieldName)
 
int getGroup ()
 
int getGroup ()
 
int getId ()
 
int getId ()
 
string getInternalName ()
 
string getInternalName ()
 
string getName ()
 
string getName ()
 
string getProgenitorFile ()
 
string getProgenitorFile ()
 
string getSuperClassNamespace ()
 
string getSuperClassNamespace ()
 
int getType ()
 
int getType ()
 
bool isChildOfGroup ()
 
bool isChildOfGroup ()
 
bool isMemberOfClass (string classname)
 
bool isMemberOfClass (string classname)
 
bool isMethod (string method name)
 
bool isMethod (string method name)
 
bool isTimerActive ()
 
bool isTimerActive ()
 
void removeFieldFilter (fieldName)
 
void removeFieldFilter (fieldName)
 
bool save (fileName,[selectedOnly])
 
bool save (fileName,[selectedOnly])
 
int schedule (time, command,< arg1...argN >)
 
int schedule (time, command,< arg1...argN >)
 
void setClassNamespace ()
 
void setClassNamespace ()
 
bool setFieldValue (fieldName, value)
 
bool setFieldValue (fieldName, value)
 
void setInternalName ()
 
void setInternalName ()
 
void setName (newName)
 
void setName (newName)
 
void setProgenitorFile (file)
 
void setProgenitorFile (file)
 
void setSuperClassNamespace ()
 
void setSuperClassNamespace ()
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
bool startTimer (callbackFunction, float timePeriod,[repeat])
 
void stopTimer ()
 
void stopTimer ()
 

Fields

SimBase
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
Namespace Linking
string superclass
 
string class
 
- Fields inherited from SimObject
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 

Methods

void NetObject::clearScopeToClient ( client  )

Use the clearScopeToClient method to undo the effects of a previous call to scopeToClient.

Parameters
clientThe ID of the client to stop forcing scoping this object for.
Returns
No return value.
See Also
scopeToClient
void NetObject::clearScopeToClient ( client  )

Use the clearScopeToClient method to undo the effects of a previous call to scopeToClient.

Parameters
clientThe ID of the client to stop forcing scoping this object for.
Returns
No return value.
See Also
scopeToClient
int NetObject::getGhostID ( )
Returns
Returns the ghost ID of the object
int NetObject::getGhostID ( )
Returns
Returns the ghost ID of the object
void NetObject::scopeToClient ( client  )

Use the scopeToClient method to force this object to be SCOPE_ALWAYS on client. When an object is SCOPE_ALWAYS it is always ghosted. Therefore, if you have an object that should always be ghosted to a client, use this method.

Parameters
clientThe ID of the client to force this object to be SCOPE_ALWAYS for.
Returns
No return value.
See Also
clearScopeToClient, setScopeAlways
void NetObject::scopeToClient ( client  )

Use the scopeToClient method to force this object to be SCOPE_ALWAYS on client. When an object is SCOPE_ALWAYS it is always ghosted. Therefore, if you have an object that should always be ghosted to a client, use this method.

Parameters
clientThe ID of the client to force this object to be SCOPE_ALWAYS for.
Returns
No return value.
See Also
clearScopeToClient, setScopeAlways
void NetObject::setScopeAlways ( )

Use the setScopeAlways method to force an object to be SCOPE_ALWAYS for all clients. When an object is SCOPE_ALWAYS it is always ghosted. Therefore, if you have an object that should always be ghosted to all clients, use this method.

Returns
No return value.
See Also
scopeToClient
void NetObject::setScopeAlways ( )

Use the setScopeAlways method to force an object to be SCOPE_ALWAYS for all clients. When an object is SCOPE_ALWAYS it is always ghosted. Therefore, if you have an object that should always be ghosted to all clients, use this method.

Returns
No return value.
See Also
scopeToClient

Member Data Documentation

bool NetObject::canSaveDynamicFields
string NetObject::class

Script SuperClass of object.

string NetObject::internalName
SimObjectPtr NetObject::parentGroup

Group hierarchy parent of the object.

string NetObject::superclass

Script Class of object.



Copyright © 2013 GarageGames, LLC. All Rights Reserved.