entities

This page contains tutorials about theentities package. Basically, theentities package provides functions and classes to create, modify, access anddelete entities. An entity is an object somewhere on the map that has a specifictype (class name) and different properties (e. g. health, position, team index,speed, model, etc.).

There are two types of entities:

  • Networked entities

  • Non-networked entities

Networked already indicates that those entities are sent over the network.Their information is shared with all players on the server. Some common examplesfor those entities are players, weapons, barrels or trigger entities.Non-networked entities are entities that only exist on the server or client, butnot on both sides. Entities are uniquely identified by an index thatstarts at 0 and can go up to theentity limit.

Note

Indexes uniquely identify an entity. However, if the entity is deleted, anew entity can reuse that index.

You will most likely want to access networked entities. Those are the mostcommon and interesting ones.

There are multiple classes in Source.Python to access the various entity types:

This tutorial will only coverentities.entity.BaseEntity andentities.entity.Entity. For the other two classes, there will beseparate tutorials.

Accessing entities

If you know the index of an entity, it’s quite simple to access it.

fromentities.entityimportEntity# Access the entity with index 0. The world entity always has the index 0.entity=Entity(0)# Print the class name of the entity. This will print "worldspawn".print(entity.classname)

However, often you need to search for entities of a specific type. E. g. to getall buy zones:

# Import the entity iteratorfromfilters.entitiesimportEntityIter# Loop through all buy zonesforbuy_zoneinEntityIter('func_buyzone'):# Print the team index of the buy zone. Only teams with the same index can# use this buy zone.print(f'Buy zone for team:{buy_zone.team_index}')# If you are not used to Python 3.6, the print statement might be# confusing at first. Alternatively, you could also write:# print('Buy zone for team: {}'.format(buy_zone.team_index))

You might wonder how to know which entity types are currently available on themap. You can easily discover that by using the following snippet.

# Import the entity iterator.fromfilters.entitiesimportEntityIter# Get the class name of every entity on the map. Use set() to get a distinct# set.classnames=set(entity.classnameforentityinEntityIter())# Sort all class names alphabetically and then print them.forclassnameinsorted(classnames):print(classname)

Modifying entities

In the previous chapter we looped through all buy zones to print their teamindexes. Now, let’s loop through all doors on the map and open them.

# Import the entity iteratorfromfilters.entitiesimportEntityIter# Loop through all doorsfordoorinEntityIter('prop_door_rotating'):# Open the doordoor.open()# Or, if you are tired of the doors, simply remove them with:# door.remove()

If you just tried to find information aboutdoor.open() on the wiki, youprobably didn’t find anything except this tutorial. This is because of all thedifferent entity types. They all have different properties and methods, whichalso differs from game to game. Thus, you can only print these information atruntime. To do so, you can use the following snippet.

fromentities.entityimportEntity# Find an entity with the class name "prop_door_rotating". If no entity was# found, it will be created.entity=Entity.find_or_create('prop_door_rotating')# Loop through all attributesforattrindir(entity):# Print the attributeprint(attr)

Creating new entities

Creating new entities is quite simple. Often you just need to create an entityof the desired type, assign it a model and then spawn it. Here is how to dothat.

# Import the required classes.fromentities.entityimportEntityfromplayers.entityimportPlayerfromengines.precacheimportModelfromeventsimportEvent# Wrap the model (a barrel) with the Model class. It will ensure that the model# is precached, when you want to use it. Precaching is important. Otherwise# the model might not work.my_model=Model('models/props_c17/oildrum001.mdl')# Listen to the player_say event. It gets fired everytime a player says# something in the chat.@Event('player_say')defon_player_say(event):# Get a Player instance for the player who typed something into the chat.player=Player.from_userid(event['userid'])# Create an entity of the type "prop_physics_multiplayer".entity=Entity.create('prop_physics_multiplayer')# Assign the model.entity.model=my_model# Set the location where the entity should be created. In this case we want# to spawn it where the player is currently looking at.entity.origin=player.view_coordinates# Finally spawn the entity.entity.spawn()

Note

The modelmodels/props_c17/oildrum001.mdl already exists in CS:S. Inother games this might be different.