GeneralRules Class |
Namespace: (Default Namespace)
[SerializableAttribute] public abstract class GeneralRules
The GeneralRules type exposes the following members.
Name | Description | |
---|---|---|
ApplyLights |
Use properties of the sprites in the specified category to configure real-time lighting on the display
for the current frame.
| |
CanReturnToPreviousMap |
Determines if there is a previous map to return to.
| |
ChangeCounter |
Change a counter's value with a pre-defined operation.
| |
ClearAllMessages |
Clears all active messages from the display.
| |
ClearOverlay |
Turn off the overlay map.
| |
Clicked |
Determines if the specified mouse button is pressed.
| |
DeactivateTargetSpriteFor |
Deactivate the sprite currently selected as the target for the specified name and clear the sprite selected for that target name.
| |
DeleteSave |
Empties the specified save slot.
| |
DragMap |
When the mouse drags over the display, scroll the map along with it.
| |
DrawMessages |
Draws all active messages.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
ExcludeCounterFromSaveUnit |
Exclude the specified counter from the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
| |
ExcludeMapFromSaveUnit |
Remove the specified map in from the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetRandomNumber |
Return a random number within a specified range.
| |
GetSelectedTargetFor |
Returns the sprite currently selected for the specified target name.
| |
GetTargetParameterFor |
Get the value of a numeric property or parameter on a sprite selected with SelectTargetSpriteFor(SpriteCollection, Int32, String).
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IncludeCounterInSaveUnit |
Include the specified counter in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
| |
IncludeInSaveUnit |
Includes a specified set of objects in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
| |
IncludeMapInSaveUnit |
Include the specified map in the SaveUnit that will be saved with the next call to SaveGame(Int32, Boolean).
| |
IsKeyPressed |
Determines if a specified key is being pressed.
| |
IsMapFlagOn |
Determine if the specified map-specific flag on the current map is on.
| |
IsMouseButtonPressed |
Determines if the specified mouse button is pressed.
| |
IsSpriteForTargetOfType |
Determine if the sprite selected for the specified target (selected with SelectTargetSpriteFor)
is of the specified type.
| |
IsTargetSpriteSelectedFor |
Determine if a sprite has been selected with SelectLastCreatedSpriteFor(String)
or SelectTargetSpriteFor(SpriteCollection, Int32, String).
| |
LimitFrameRate |
Limit the frame rate of the game to the specified number of frames per second. Call this only once per frame.
| |
LoadGame |
Restore the state of the objects contained in the specified save slot.
| |
LogDebugLabel |
Write a string to the debug output without moving to the next line.
| |
LogDebugValue |
Write a number to the debug output and move to the next line.
| |
PlayerPressButton |
Handles button pressses from a player with respect to displayed messages
| |
QuitGame |
Quit the game by closing the main window.
| |
ResetLights |
Reset all light sources to initial default behavior.
| |
ReturnToPreviousMap |
Return to the map that was active before the last SwitchToMap(Type, Boolean).
| |
SaveExists |
Determines if saved game data exists in the specified slot.
| |
SaveGame |
Save the current SaveUnit into the specified save slot.
| |
SelectLastCreatedSprite |
Select the most recently created sprite to be the target of SetTargetParameter(String, Int32).
| |
SelectLastCreatedSpriteFor |
Selects the most recently created sprite to be the target of SetTargetParameterFor(String, Int32, String)
or GetTargetParameterFor(String, String).
| |
SelectTargetSprite |
Selects a sprite within a collection, using a 0-based index, to be the target of SetTargetParameter(String, Int32).
| |
SelectTargetSpriteFor |
Selects a sprite within a collection, using a 0-based index, to be the target of SetTargetParameterFor(String, Int32, String).
TargetName allows any number of unique targets to be selected by assigning unique names.
| |
SetCategorySpriteState |
Sets the current state of a sprite based on a category and index into the category.
| |
SetMapFlag |
Turn on or off a flag associated with the current map.
| |
SetMessageBackground |
Sets the background for new messages added with ShowMessage(String).
| |
SetMessageDismissal |
Determines which player and which button will dismiss newly created messages.
| |
SetMessageFont |
Set the tileset used as the source for characters in messages.
| |
SetMessagePosition |
Determines where newly created messages appear.
| |
SetOverlay |
Set the overlay map.
| |
SetTargetMapFlag |
Turn on or off a flag associated with the specified map.
| |
SetTargetParameter |
Set the value of a numeric property or parameter on a sprite selected with SelectTargetSprite(SpriteCollection, Int32) to the specified value.
| |
SetTargetParameterFor |
Set the value of a numeric property or parameter on a sprite selected with SelectTargetSpriteFor(SpriteCollection, Int32, String) to the specified value.
| |
SetViewLayout |
Sets the layout of multiple views for the current map.
| |
ShowMessage |
Adds a message to the display.
| |
SwitchToMap |
Sets a different map as the one to be drawn on the game display.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
UnloadBackgroundMaps |
Unload all maps that aren't currently visible.
| |
UnloadMap |
Unloads the specified map.
|
Name | Description | |
---|---|---|
lastCreatedSprite |
Contains the last sprite created with AddSpriteAtPlan(Type, RelativePosition),
TileAddSprite(Int32, Type) or AddSpriteHere(Type, RelativePosition, RelativePosition).
|
Name | Description | |
---|---|---|
CurrentView |
If multiple views are visible, this determines which view is currently active.
| |
ParentLayer |
Retrieves the layer that contains this object.
|