Trees       Indices       Help   
Blender Game API post 2.49a (26/08/2009)
Module GameTypes :: Class KX_LightObject
[hide private]
[frames] | no frames]

Class KX_LightObject

source code

PyObjectPlus --+            
               |            
          CValue --+        
                   |        
         SCA_IObject --+    
                       |    
           KX_GameObject --+
                           |
                          KX_LightObject

A Light object.

Example:

# Turn on a red alert light. import GameLogic

co = GameLogic.getCurrentController() light = co.owner

light.energy = 1.0 light.colour = [1.0, 0.0, 0.0]

Instance Methods [hide private]
    Deprecated
    Property Access
    Inherited from KX_GameObject
 
alignAxisToVect(vect, axis, factor)
Aligns any of the game object's axis along the given vector.		 source code
 
applyForce(force, local=0)
Sets the game object's force.		 source code
 
applyImpulse(point, impulse)
Applies an impulse to the game object.		 source code
 
applyMovement(movement, local=0)
Sets the game object's movement.		 source code
 
applyRotation(rotation, local=0)
Sets the game object's rotation.		 source code
 
applyTorque(torque, local=0)
Sets the game object's torque.		 source code
 
disableRigidBody()
Disables rigid body physics for this object.		 source code
 
enableRigidBody()
Enables rigid body physics for this object.		 source code
 
endObject()
Delete this object, can be used inpace of the EndObject Actuator.		 source code
list [vx, vy, vz]
getAngularVelocity(local=0)
Gets the game object's angular velocity.		 source code
3d vector.
getAxisVect(vect)
Returns the axis vector rotates by the objects worldspace orientation.		 source code
float
getDistanceTo(other)
Returns the distance to another object or point.		 source code
list [vx, vy, vz]
getLinearVelocity(local=0)
Gets the game object's linear velocity.		 source code
 
getPhysicsId()
Returns the user data object associated with this game object's physics controller.		 source code
list [fx, fy, fz]
getReactionForce()
Gets the game object's reaction force.		 source code
3-tuple (float, 3-tuple (x,y,z), 3-tuple (x,y,z))
getVectTo(other)
Returns the vector and the distance to another object or point.		 source code
list [vx, vy, vz]
getVelocity(point)
Gets the game object's velocity at the specified point.		 source code
3-tuple (KX_GameObject, 3-tuple (x,y,z), 3-tuple (nx,ny,nz)) or 4-tuple (KX_GameObject, 3-tuple (x,y,z), 3-tuple (nx,ny,nz), KX_PolyProxy)
rayCast(objto, objfrom, dist, prop, face, xray, poly)
Look from a point/object to another point/object and find first object hit within dist that matches prop.		 source code
KX_GameObject
rayCastTo(other, dist, prop)
Look towards another point/object and find first object hit within dist that matches prop.		 source code
boolean
reinstancePhysicsMesh(gameObject, meshObject)
Updates the physics system with the changed mesh.		 source code
 
removeParent()
Removes this objects parent.		 source code
 
replaceMesh(mesh, useDisplayMesh=True, usePhysicsMesh=False)
Replace the mesh of this object with a new mesh.		 source code
 
restoreDynamics()
Resumes physics for this object.		 source code
 
sendMessage(subject, body='', to='')
Sends a message.		 source code
 
setAngularVelocity(velocity, local=0)
Sets the game object's angular velocity.		 source code
 
setCollisionMargin(margin)
Set the objects collision margin.		 source code
 
setLinearVelocity(velocity, local=0)
Sets the game object's linear velocity.		 source code
 
setOcclusion(occlusion, recursive)
Sets the game object's occlusion capability.		 source code
 
setParent(parent, compound, ghost)
Sets this object's parent.		 source code
 
setVisible(visible, recursive)
Sets the game object's visible flag.		 source code
 
suspendDynamics()
Suspends physics for this object.		 source code
CListValue of KX_GameObject
getChildren()
Return a list of immediate children of this object.		 source code
CListValue of KX_GameObject
getChildrenRecursive()
Return a list of children of this object, including all their childrens children.		 source code
float
getMass()
Gets the game object's mass.		 source code
KX_MeshProxy
getMesh(mesh)
Gets the mesh object for this object.		 source code
3x3 rotation matrix
getOrientation()
Gets the game object's orientation.		 source code
KX_GameObject
getParent()
Gets this object's parent.		 source code
list [x, y, z]
getPosition()
Gets the game object's position.		 source code
int
getState()
Gets the game object's state bitmask.		 source code
boolean
getVisible()
Gets the game object's visible flag.		 source code
 
setOrientation(orn)
Sets the game object's orientation.		 source code
 
setPosition(pos)
Sets the game object's position.		 source code
 
setState(state)
Sets the game object's state flag.		 source code
 
setWorldPosition(pos)
Sets the game object's position in world coordinates regardless if the object is root or child.		 source code
 
get(key, default=None)
Return the value matching key, or the default value if its not found.		 source code
list
getPropertyNames()
Gets a list of all property names.		 source code
boolean
has_key(key)
Return True if the key is found.		 source code
    Inherited from CValue
string
getName()
Returns the name of the CValue.		 source code
    Inherited from PyObjectPlus
bool
isA(game_type)
Check if this is a type or a subtype game_type.		 source code
Instance Variables [hide private]
  color
Synonym for colour.
list [r, g, b] colour
The colour of this light.
float distance
The maximum distance this light can illuminate.
float energy
The brightness of this light.
bitfield layer
The layer mask that this light affects object on.
float lin_attenuation
The linear component of this light's attenuation.
float quad_attenuation
The quadratic component of this light's attenuation (SPOT and NORMAL lights only)
  spotblend
Specifies the intensity distribution of the spot light.
  spotsize
The cone angle of the spot light, in degrees.
  type
The type of light - must be SPOT, SUN or NORMAL
    Constants
  NORMAL
A point light source.
  SPOT
A spot light source.
  SUN
A point light source with no attenuation.
    Property Access
    Inherited from KX_GameObject
list actuators
a list of SCA_IActuator with string/index lookups and iterator support.
CListValue of KX_GameObject's children
direct children of this object, (read-only).
CListValue of KX_GameObject's childrenRecursive
all children of this object including childrens children, (read-only).
list of SCA_ISensor. controllers
a sequence of SCA_IController objects with string/index lookups and iterator support.
float linVelocityMax
Clamp the maximum linear velocity to prevent objects moving beyond a set speed.
float linVelocityMin
Enforces the object keeps moving at a minimum velocity.
list [ix, iy, iz] localInertia
the object's inertia vector in local coordinates.
3x3 Matrix [[float]] localOrientation
The object's local orientation.
list [x, y, z] localPosition
The object's local position.
list [sx, sy, sz] localScale
The object's local scaling factor.
float mass
The object's mass
list of KX_MeshProxy meshes
a list meshes for this object.
string name
The name of this CValue derived object (read-only).
boolean occlusion
occlusion capability flag.
3x3 Matrix [[float]] On write: local orientation, on read: world orientation orientation
The object's orientation.
KX_GameObject or None parent
The object's parent object.
list [x, y, z] On write: local position, on read: world position position
The object's position.
list [sx, sy, sz] On write: local scaling, on read: world scaling scaling
The object's scaling factor.
list sensors
a sequence of SCA_ISensor objects with string/index lookups and iterator support.
int state
the game object's state bitmask, using the first 30 bits, one bit must always be set.
float timeOffset
adjust the slowparent delay at runtime.
boolean visible
visibility flag.
3x3 Matrix [[float]] worldOrientation
The object's world orientation.
list [x, y, z] worldPosition
The object's world position.
list [sx, sy, sz] worldScale
The object's world scaling factor.
dict attrDict
get the objects internal python attribute dictionary for direct (faster) access.
    Inherited from PyObjectPlus
bool invalid
Test if the object has been freed by the game engine and is no longer valid.
Instance Variable Details [hide private]

NORMAL

A point light source. See attribute 'type'

SPOT

A spot light source. See attribute 'type'

SUN

A point light source with no attenuation. See attribute 'type'

colour

The colour of this light. Black = [0.0, 0.0, 0.0], White = [1.0, 1.0, 1.0]
Type:
list [r, g, b]

distance

The maximum distance this light can illuminate. (SPOT and NORMAL lights only)
Type:
float

lin_attenuation

The linear component of this light's attenuation. (SPOT and NORMAL lights only)
Type:
float

spotblend

Specifies the intensity distribution of the spot light. (float) (SPOT lights only) Higher values result in a more focused light source. 0.0 <= spotblend <= 1.0.

spotsize

The cone angle of the spot light, in degrees. (float) (SPOT lights only) 0.0 <= spotsize <= 180.0. Spotsize = 360.0 is also accepted.

   Trees       Indices       Help   
Blender Game API post 2.49a (26/08/2009)
Generated by Epydoc 3.0beta1 on Wed Aug 26 12:07:40 2009 http://epydoc.sourceforge.net