Objects

This page contains an alphabetical list of all objects in the API.

stingray.Achievements Interface to access achievements on xbox one.

stingray.Actor Interface to a physics actor.

stingray.ActorBox A "box" that stores an Actor object across multiple frames, ensuring that the stored Actor has not become invalid by being destroyed in the physics world.

stingray.ActorComponent A component that can store arbitrary values accessed by keys.

stingray.AnimationBlenderComponent A component that handles animation blending for an entity.

stingray.AnimationCurves An interface for sampling custom animation curves.

stingray.AnimationStateMachineComponent A component that handles animation state machines for an entity.

stingray.BoundingVolume An opaque object that represents a three-dimensional oriented bounding box.

stingray.Broadphase A data structure that you can use to quickly search for units in a game level.

stingray.Camera Represents a game camera.

stingray.Cloth Represents an Apex Cloth actor.

stingray.CloudToken An opaque object returned by several asynchronous functions in the stingray.Cloud interface.

stingray.DataComponent A component that can store arbitrary values accessed by keys.

stingray.DebugNameComponent A component that stores a debug name for the entity.

stingray.DynamicData References script data obtained from a LevelResource by calling stingray.LevelResource.data() or stingray.LevelResource.unit_data().

stingray.Entity Opaque object representing an entity.

stingray.Float32Array A data structure that represents an array of float.

stingray.FlowComponent A component that adds flow to an entity.

stingray.GameSession The GameSession object is responsible for replicating and synchronizing game objects between the peers that participate in a networked game session.

stingray.Gui A Gui is an object that manages primitive 2D shapes -- like rectangles, triangles, and text -- and draws them in the engine viewport.

stingray.GwNavAStar Provides access to the main PathFinding Query of Navigation.

stingray.GwNavBot Represents a Navigation bot.

stingray.GwNavBoxObstacle Represents a dynamic box obstacle.

stingray.GwNavCylinderObstacle Represents a dynamic cylinder obstacle.

stingray.GwNavData Represents a Navigation NavData.

stingray.GwNavDatabase Represents a Navigation database.

stingray.GwNavGeneration Functions used for generating NavData.

stingray.GwNavGenSectorNeighborsIterator

stingray.GwNavGraph Represents a graph of points.

stingray.GwNavQueryDynamicOutput Provides access to some output from GwNavQueries.

stingray.GwNavSmartObjectInterval Represents the Entrance and Exit points for a [GwNavSmartObject].

stingray.GwNavTagLayerCostTable Allows to customize GwNavTraverseLogicData.

stingray.GwNavTagVolume Represents a volume that tags the NavMesh dynamically.

stingray.GwNavTraverseLogicData Allows to customize queries and pathfinding.

stingray.GwNavTriangle Represents a NavMesh Triangle.

stingray.GwNavWorld Represents a Navigation world.

stingray.IdString32 A hashed string value.

stingray.IdString32Box A "box" that stores a IdString32Box object across multiple frames.

stingray.IdString64 A hashed string value.

stingray.IdString64Box A "box" that stores a IdString64Box object across multiple frames.

stingray.Joint Interface to a physics joint.

stingray.LanClient Represents a network node in a LAN game.

stingray.LanLobby Represents a lobby in a LAN game.

stingray.LanLobbyBrowser The LanLobbyBrowser provides access to the list of game lobbies available on the local area network (LAN).

stingray.LeaderboardTransactionToken An opaque token returned by asychronous functions in the Steam Leaderboard interface.

stingray.Level Represents a level that has been loaded into the runtime game world.

stingray.Light Describes a game light.

stingray.LineObject Used to draw debug lines in the game world.

stingray.Localizer The Localizer is a helper interface that offers access to localized strings that are contained in a single specified .strings resource.

stingray.LODObject This interface provides a Level of Detail selector: a wrapper over a number of mesh objects that selects which mesh should be rendered depending on the screen space projection of the LOD object's bounding sphere.

stingray.Material Represents a material.

stingray.Matrix4x4 Represents a 4x4 matrix that stores both the position and the orientation of an object.

stingray.Matrix4x4Box A "box" that stores a Matrix4x4 object across multiple frames.

stingray.Mesh Describes a mesh.

stingray.MeshComponent A component that can store arbitrary values accessed by keys.

stingray.Mover Provides an interface to a physics mover / character controller.

stingray.MultiplayerSessionRestriction Matches the Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionRestriction enum in the XDK documentation.

stingray.MultiplayerSessionVisibility Matches the Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionVisibility enum in the XDK documentation.

stingray.NavigationMesh A navigation mesh in a level.

stingray.PeoplehubDetailLevel Matches the Microsoft.Xbox.Services.Experimental.Social.Manager.PeoplehubDetailLevel enum in the XDK documentation.

stingray.PhysicsWorld Represents a physics world: a collection of interacting physics objects where Actors live.

stingray.PreserveSessionMode Matches the Microsoft.Xbox.Services.Matchmaking.PreserveSessionMode enum in the XDK documentation.

stingray.ProceduralMesh API for manipulating procedurally generated meshes.

stingray.PsnClient Represents a network node in a PlayStation Network (PSN) game.

stingray.PsnRoom Represents a room in a PlayStation Network (PSN) game.

stingray.PsnRoomBrowser The PsnRoomBrowser provides access to the list of game rooms available on the PlayStation Network (PSN).

stingray.Quaternion Represents a rotation in the quaternion formulation (x, y, z, w).

stingray.QuaternionBox A "box" that stores a Quaternion object across multiple frames.

stingray.Raycast This object allows you to perform collision tests against the physics objects in a PhysicsWorld.

stingray.RefTracker RefTracker is a heavy userdata object that you can use to track down memory leaks in Lua.

stingray.RenderBuffer API for manipulating buffers of data for rendering.

stingray.RenderDataComponent A component that can store arbitrary values accessed by keys.

stingray.RenderResource Opaque object representing a RenderResource

stingray.Replay The Replay object can be used to replay events that have occurred in the game world.

stingray.ResourcePackage An interface for loading and unloading packages (groups of resources that you define in data files with the .package extension).

stingray.SaveToken An opaque object returned by several asynchronous functions in the stingray.SaveSystem interface.

stingray.ScatterSystem Used to spawn large number of units.

stingray.SceneGraphComponent A component that assigns a scene graph (node hierarchy) to an entity.

stingray.ScriptComponent A component that adds scripting support to entities.

stingray.SessionJobStatus These constants may be returned by calls to stingray.Network.clean_sessions_status().

stingray.ShadingEnvironment NOTE: This object and its API are considered deprecated in favor of the workflow based on entities.

stingray.SmartMatchStatus Status of the SmartMatch matchmaking.

stingray.SocialEventType Matches the Microsoft.Xbox.Services.Experimental.Social.Manager.SocialEventType enum in the XDK documentation.

stingray.SocialPresenceFilter Matches the Microsoft.Xbox.Services.Experimental.Social.Manager.PresenceFilter enum in the XDK documentation.

stingray.SocialRelationshipFilter Matches the Microsoft.Xbox.Services.Experimental.Social.Manager.RelationshipFilter enum in the XDK documentation.

stingray.SoundStreamSource

stingray.SteamClient Represents a client network node in a Steam game.

stingray.SteamGameServer Represents a server node in a Steam game.

stingray.SteamGameServerLobby Represents a lobby for a game server.

stingray.SteamLobby Represents a lobby in a Steam game.

stingray.SteamLobbyBrowser The SteamLobbyBrowser provides access to the list of game lobbies available on the Steam.

stingray.SteamPingThread Used to measure the ping time, which reports how fast messages can be bounced between the two network cards.

stingray.SteamServerBrowser The SteamServerBrowser provides access to the list of game servers available on Steam.

stingray.SteamVoipClient This represents a client that can communicate with others in a room.

stingray.StoryTeller A class that can play stories, or cutscenes.

stingray.TagComponent A component that handles tags for an entity.

stingray.Terrain Represents a terrain.

stingray.TransferStatus Matches the Windows.Xbox.Management.Deployment.PackageTransferStatus enum in the XDK documentation.

stingray.TransformComponent A component that lets entities be positioned in the world.

stingray.Unit Each Unit object represents a single game unit, such as a character, a building, or another object in a game level.

stingray.UnitComponent A component that links a unit to an entity.

stingray.UnitSynchronizer The UnitSynchronizer is a helper object that synchronizes the creation, destruction, position and rotation of units across multiple networked peers.

stingray.Vector2 Describes a three-dimensional vector.

stingray.Vector2Box A "box" that stores a Vector2 object across multiple frames.

stingray.Vector3 Describes a three-dimensional vector.

stingray.Vector3Box A "box" that stores a Vector3 object across multiple frames.

stingray.Vector4 Describes a three-dimensional vector.

stingray.Vector4Box A "box" that stores a Vector4 object across multiple frames.

stingray.VectorField Represents a vector field.

stingray.Vehicle Interface to a physics vehicle.

stingray.VideoPlayer An object that can play video.

stingray.Viewport Represents a viewport: a container for a view into the 3D world.

stingray.VoiceChatParticipantType Matches the Windows.Xbox.Chat.ChatParticipantTypes enum in the XDK documentation.

stingray.VoiceChatRestriction Matches the Windows.Xbox.Chat.ChatRestriction enum in the XDK documentation.

stingray.VoiceChatTalkingMode Matches the Microsoft.Xbox.GameChat.ChatUserTalkingMode enum in the XDK documentation.

stingray.WebSocket Implements a web socket client interface.

stingray.Window Represents an application window on Win32 and MacOS X.

stingray.World Represents a game world.

stingray.WwiseWorld This object provides access to functions for controlling sound events for a particular game World.

stingray.XboxOne This object is a container for constants that reflect the state of the Xbox One device.