OOJSEntity.h File Reference

import <Foundation/Foundation.h>
import "OOJavaScriptEngine.h"
import "Universe.h"

Include dependency graph for OOJSEntity.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	InitOOJSEntity (JSContext *context, JSObject *global)
BOOL	JSValueToEntity (JSContext *context, jsval value, Entity **outEntity)
OOINLINE JSClass *	JSEntityClass (void)
OOINLINE JSObject *	JSEntityPrototype (void)
BOOL	EntityFromArgumentList (JSContext *context, NSString *scriptClass, NSString *function, uintN argc, jsval *argv, Entity **outEntity, uintN *outConsumed)
OOINLINE BOOL	OOIsPlayerStale (void)
OOINLINE BOOL	OOIsStaleEntity (Entity *entity)

Variables
JSClass	gOOEntityJSClass
JSObject *	gOOEntityJSPrototype

Function Documentation

EntityFromArgumentList()

BOOL EntityFromArgumentList	(	JSContext *	context,
		NSString *	scriptClass,
		NSString *	function,
		uintN	argc,
		jsval *	argv,
		Entity **	outEntity,
		uintN *	outConsumed
	)

Definition at line 157 of file OOJSEntity.m.

{
    OOJS_PROFILE_ENTER
    
    // Sanity checks.
    if (outConsumed != NULL)  *outConsumed = 0;
    if (EXPECT_NOT(argc == 0 || argv == NULL || outEntity == NULL))
    {
        OOLogGenericParameterError();
        return NO;
    }
    
    // Get value, if possible.
    if (EXPECT_NOT(!JSValueToEntity(context, argv[0], outEntity)))
    {
        // Failed; report bad parameters, if given a class and function.
        if (scriptClass != nil && function != nil)
        {
            OOJSReportWarning(context, @"%@.%@(): expected entity, got %@.", scriptClass, function, [NSString stringWithJavaScriptParameters:argv count:1 inContext:context]);
            return NO;
        }
    }
    
    // Success.
    if (outConsumed != NULL)  *outConsumed = 1;
    return YES;
    
    OOJS_PROFILE_EXIT
}

References count, EXPECT_NOT, JSValueToEntity(), nil, OOJS_PROFILE_ENTER, OOJS_PROFILE_EXIT, OOJSReportWarning(), and OOLogGenericParameterError.

Here is the call graph for this function:

InitOOJSEntity()

void InitOOJSEntity	(	JSContext *	context,
		JSObject *	global
	)

Definition at line 139 of file OOJSEntity.m.

{
    gOOEntityJSPrototype = JS_InitClass(context, global, NULL, &gOOEntityJSClass, OOJSUnconstructableConstruct, 0, sEntityProperties, sEntityMethods, NULL, NULL);
    OOJSRegisterObjectConverter(&gOOEntityJSClass, OOJSBasicPrivateObjectConverter);
}

References gOOEntityJSClass, gOOEntityJSPrototype, OOJSBasicPrivateObjectConverter(), OOJSRegisterObjectConverter(), OOJSUnconstructableConstruct(), sEntityMethods, and sEntityProperties.

Here is the call graph for this function:

JSEntityClass()

OOINLINE JSClass * JSEntityClass

(

void

)

Definition at line 42 of file OOJSEntity.h.

{ return &gOOEntityJSClass; }

References gOOEntityJSClass.

Referenced by InitOOJSExhaustPlume(), InitOOJSFlasher(), InitOOJSPlanet(), InitOOJSShip(), InitOOJSSun(), InitOOJSVisualEffect(), InitOOJSWaypoint(), InitOOJSWormhole(), JSObjectGetQuaternion(), and JSObjectGetVector().

Here is the caller graph for this function:

JSEntityPrototype()

OOINLINE JSObject * JSEntityPrototype

(

void

)

Definition at line 43 of file OOJSEntity.h.

{ return gOOEntityJSPrototype; }

References gOOEntityJSPrototype.

Referenced by InitOOJSExhaustPlume(), InitOOJSFlasher(), InitOOJSPlanet(), InitOOJSShip(), InitOOJSSun(), InitOOJSVisualEffect(), InitOOJSWaypoint(), and InitOOJSWormhole().

Here is the caller graph for this function:

JSValueToEntity()

BOOL JSValueToEntity	(	JSContext *	context,
		jsval	value,
		Entity **	outEntity
	)

Definition at line 146 of file OOJSEntity.m.

{
    if (JSVAL_IS_OBJECT(value))
    {
        return OOJSEntityGetEntity(context, JSVAL_TO_OBJECT(value), outEntity);
    }
    
    return NO;
}

Referenced by ConsoleInspectEntity(), EntityFromArgumentList(), GetRelativeToAndRange(), PlayerShipSetProperty(), and ShipSetProperty().

Here is the caller graph for this function:

OOIsPlayerStale()

OOINLINE BOOL OOIsPlayerStale

(

void

)

Definition at line 65 of file OOJSEntity.h.

{
    extern Entity *gOOJSPlayerIfStale;
    return gOOJSPlayerIfStale != nil;
}

References gOOJSPlayerIfStale, and nil.

Referenced by PlayerSetEscapePodDestination(), PlayerShipAwardEquipmentToCurrentPylon(), PlayerShipCancelDockingRequest(), PlayerShipDisengageAutopilot(), PlayerShipEngageAutopilotToStation(), PlayerShipGetProperty(), PlayerShipLaunch(), PlayerShipRemoveAllCargo(), PlayerShipRequestDockingClearance(), PlayerShipSetProperty(), and PlayerShipUseSpecialCargo().

Here is the caller graph for this function:

OOIsStaleEntity()

OOINLINE BOOL OOIsStaleEntity

(

Entity *

entity

)

Definition at line 71 of file OOJSEntity.h.

{
    extern Entity *gOOJSPlayerIfStale;
    return entity == nil || (entity == gOOJSPlayerIfStale);
}

References gOOJSPlayerIfStale, and nil.

Referenced by EntityGetProperty(), EntitySetProperty(), ShipGetProperty(), and ShipSetProperty().

Here is the caller graph for this function:

Variable Documentation

gOOEntityJSClass

JSClass gOOEntityJSClass

extern

Definition at line 48 of file OOJSEntity.m.

{
    "Entity",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,        // addProperty
    JS_PropertyStub,        // delProperty
    EntityGetProperty,      // getProperty
    EntitySetProperty,      // setProperty
    JS_EnumerateStub,       // enumerate
    JS_ResolveStub,         // resolve
    JS_ConvertStub,         // convert
    OOJSObjectWrapperFinalize,// finalize
    JSCLASS_NO_OPTIONAL_MEMBERS
};

Referenced by InitOOJSEntity(), and JSEntityClass().

gOOEntityJSPrototype

JSObject* gOOEntityJSPrototype

extern

Definition at line 38 of file OOJSEntity.m.

Referenced by InitOOJSEntity(), and JSEntityPrototype().